Merge pull request apiaryio#72 from apiaryio/abtris/read-bom

Add reading apiary file with BOM

features/fixtures/apiary_with_bom.apib

@@ -0,0 +1,48 @@
+FORMAT: 1A
+
+# Apiary Client Test - DON'T CHANGE DOCUMENT!
+
+This document is used for testing apiary-client
+
+# Group Notes
+Notes related resources of the **Notes API**
+
+## Notes Collection [/notes
+### List all Notes [GET]
++ Response 200 (application/json)
+
+        [{
+          "id": 1, "title": "Jogging in park"
+        }, {
+          "id": 2, "title": "Pick-up posters from post-office"
+        }]
+
+### Create a Note [POST
+
++ Request
+
+sflmvs;mv;dsm{ "title": "Buy cheese and bread for breakfast." }
+
++ Response 201 (application/json)
+
+        { "id": 3, "title": "Buy cheese and bread for breakfast." }
+
+## Note [/notes/{id}]
+A single Note object with all its details
+
++ Parameters
+    + id (required, number, `1`) ... Numeric `id` of the Note to perform action with. Has example value.
+
+### Retrieve a Note [GET]
++ Response 200 (application/json)
+
+    + Header
+
+            X-My-Header: The Value
+
+    + Body
+
+            { "id": 2, "title": "Pick-up posters from post-office" }
+
+### Remove a Note [DELETE]
++ Response 204

lib/apiary/command/publish.rb

@@ -49,6 +49,11 @@ def validate_apib_file(apib_file)
         common.validate_apib_file(apib_file)
       end
 
+      def get_apib_file(apib_file)
+        common = Apiary::Common.new
+        common.get_apib_file(apib_file)
+      end
+
       def path
         @options.path || "#{File.basename(Dir.pwd)}.apib"
       end
@@ -57,7 +62,7 @@ def query_apiary(host, path)
         url  = "https://#{host}/blueprint/publish/#{@options.api_name}"
         if validate_apib_file path
           data = {
-            :code => File.read(path),
+            :code => get_apib_file(path),
             :messageToSave => @options.commit_message
           }
           RestClient.proxy = @options.proxy

lib/apiary/common.rb

@@ -9,12 +9,21 @@ class Common
       def initialize()
       end
 
+      def get_apib_file(apib_file)
+        if validate_apib_file(apib_file)
+          text_without_bom = nil
+          File.open(apib_file, "r:bom|utf-8") { |file|
+            text_without_bom = file.read
+          }
+          text_without_bom
+        end
+      end
+
       def validate_apib_file(apib_file)
         unless File.exist?(apib_file)
           raise "Apiary definition file hasn't been found: #{apib_file.inspect}"
         end
-        File.read(apib_file)
+        true
       end
-
     end
 end

spec/common_spec.rb

@@ -16,4 +16,14 @@
 
   end
 
+  describe 'Test get file with and without BOM' do
+
+    it 'get file and compare' do
+      common = Apiary::Common.new
+      file1 = common.get_apib_file('features/fixtures/apiary.apib')
+      file2 = common.get_apib_file('features/fixtures/apiary_with_bom.apib')
+      expect(file1).to eq(file2)
+    end
+  end
+
 end