apiaryio 0.3.5 → 0.4.1

data/lib/apiary/command/preview.rb

@@ -6,14 +6,14 @@ require 'json'
 require 'tmpdir'
 require 'erb'
 
-require "apiary/common"
-require "apiary/helpers/javascript_helper"
+require 'apiary/agent'
+require 'apiary/helpers'
+require 'apiary/helpers/javascript_helper'
 
-module Apiary
-  module Command
+module Apiary::Command
     # Display preview of local blueprint file
     class Preview
-
+      include Apiary::Helpers
       include Apiary::Helpers::JavascriptHelper
 
       PREVIEW_TEMPLATE_PATH = "#{File.expand_path File.dirname(__FILE__)}/../file_templates/preview.erb"
@@ -28,7 +28,7 @@ module Apiary
 
       def initialize(opts)
         @options = OpenStruct.new(opts)
-        @options.path         ||= 'apiary.apib'
+        @options.path         ||= '.'
         @options.api_host     ||= 'api.apiary.io'
         @options.port         ||= 8080
         @options.proxy        ||= ENV['http_proxy']
@@ -37,10 +37,14 @@ module Apiary
         @options.headers      ||= {
           :accept => 'text/html',
           :content_type => 'text/plain',
-          :user_agent => "Apiary Client Gem (https://help.apiary.io/tools/apiary-cli/)"
+          :user_agent => Apiary.user_agent
         }
 
-        validate_apib_file
+        begin
+          @source_path = api_description_source_path(@options.path)
+        rescue Exception => e
+          abort "#{e.message}"
+        end
       end
 
       def execute
@@ -52,24 +56,25 @@ module Apiary
       end
 
       def server
-        run_server
-      end
+        app = self.rack_app do
+          generate
+        end
 
-      def show
-        generate_static
+        Rack::Server.start(:Port => @options.port, :Host => @options.host, :app => app)
       end
 
-      def validate_apib_file
-        common = Apiary::Common.new
-        common.validate_apib_file(@options.path)
-      end
+      def show
+        preview_string = generate
 
-      def path
-        @options.path || "#{File.basename(Dir.pwd)}.apib"
+        File.open(preview_path, 'w') do |file|
+          file.write preview_string
+          file.flush
+          @options.output ? write_generated_path(file.path, @options.output) : open_generated_page(file.path)
+        end
       end
 
       def browser
-        BROWSERS[@options.browser]  || nil
+        BROWSERS[@options.browser] || nil
       end
 
       def rack_app(&block)
@@ -78,14 +83,6 @@ module Apiary
         end
       end
 
-      def run_server
-        app = self.rack_app do
-          generate
-        end
-
-        Rack::Server.start(:Port => @options.port, :Host => @options.host, :app => app)
-      end
-
       # TODO: add linux and windows systems
       def open_generated_page(path)
         exec "open #{browser_options} #{path}"
@@ -99,30 +96,15 @@ module Apiary
         template = load_preview_template
 
         data = {
-          title: File.basename(@options.path, '.*'),
-          blueprint: load_blueprint
+          title: File.basename(@source_path, '.*'),
+          source: api_description_source(@source_path)
         }
 
         template.result(binding)
       end
 
-      def generate_static
-        preview_string = generate
-
-        File.open(preview_path, 'w') do |file|
-          file.write preview_string
-          file.flush
-          @options.output ? write_generated_path(file.path, @options.output) : open_generated_page(file.path)
-        end
-      end
-
-      def load_blueprint
-        file = File.open @options.path, 'r'
-        file.read
-      end
-
       def preview_path
-        basename = File.basename(@options.path, '.*')
+        basename = File.basename(@source_path, '.*')
         temp = Dir.tmpdir
         "#{temp}/#{basename}-preview.html"
       end
@@ -139,5 +121,4 @@ module Apiary
         "-a #{BROWSERS[@options.browser.to_sym]}" if @options.browser
       end
     end
-  end
 end

data/lib/apiary/command/publish.rb

@@ -3,69 +3,65 @@ require 'rest-client'
 require 'rack'
 require 'ostruct'
 require 'json'
-require "apiary/common"
 
-module Apiary
-  module Command
+require 'apiary/agent'
+require 'apiary/helpers'
+
+module Apiary::Command
     # Display preview of local blueprint file
     class Publish
+      include Apiary::Helpers
 
       attr_reader :options
 
       def initialize(opts)
         @options = OpenStruct.new(opts)
-        @options.path           ||= "apiary.apib"
-        @options.api_host       ||= "api.apiary.io"
+        @options.path           ||= '.'
+        @options.api_host       ||= 'api.apiary.io'
         @options.api_name       ||= false
         @options.api_key        ||= ENV['APIARY_API_KEY']
         @options.proxy          ||= ENV['http_proxy']
         @options.headers        ||= {
-          :accept => "text/html",
-          :content_type => "text/plain",
+          :accept => 'text/html',
+          :content_type => 'text/plain',
           :authentication => "Token #{@options.api_key}",
-          :user_agent => "Apiary Client Gem (https://help.apiary.io/tools/apiary-cli/)"
+          :user_agent => Apiary.user_agent
         }
-        @options.message ||= "Saving blueprint from apiary-client"
+        @options.message ||= 'Saving API Description Document from apiary-client'
+
+        begin
+          @source_path = api_description_source_path(@options.path)
+        rescue Exception => e
+          abort "#{e.message}"
+        end
       end
 
-      def execute()
+      def execute
         publish_on_apiary
       end
 
       def publish_on_apiary
         unless @options.api_name
-          abort "Please provide an api-name option (subdomain part from your http://docs.<api-name>.apiary.io/)"
+          abort 'Please provide an api-name option (subdomain part from your http://docs.<api-name>.apiary.io/)'
         end
 
         unless @options.api_key
-          abort "API key must be provided through environment variable APIARY_API_KEY. Please go to https://login.apiary.io/tokens to obtain it."
+          abort 'API key must be provided through environment variable APIARY_API_KEY. Please go to https://login.apiary.io/tokens to obtain it.'
         end
 
-        self.query_apiary(@options.api_host, @options.path)
-
+        query_apiary
       end
 
-      def validate_apib_file(apib_file)
-        common = Apiary::Common.new
-        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 query_apiary
+        url  = "https://#{@options.api_host}/blueprint/publish/#{@options.api_name}"
+        source = api_description_source(@source_path)
 
-      def path
-        @options.path || "#{File.basename(Dir.pwd)}.apib"
-      end
-
-      def query_apiary(host, path)
-        url  = "https://#{host}/blueprint/publish/#{@options.api_name}"
-        if validate_apib_file path
+        unless source.nil?
           data = {
-            :code => get_apib_file(path),
+            :code => source,
             :messageToSave => @options.message
           }
+
           RestClient.proxy = @options.proxy
 
           begin
@@ -87,12 +83,5 @@ module Apiary
           end
         end
       end
-
-      private
-        def api_name
-          "-a"
-        end
-
     end
-  end
 end

data/lib/apiary/file_templates/preview.erb

@@ -8,7 +8,7 @@
   <script src="https://api.apiary.io/seeds/embed.js"></script>
   <script>
     var embed = new Apiary.Embed({
-      apiBlueprint: "<%= escape_javascript data[:blueprint] %>"
+      apiBlueprint: "<%= escape_javascript data[:source] %>"
     });
   </script>
 </body>

data/lib/apiary/helpers.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+module Apiary
+  module Helpers
+    def api_description_source_path(path)
+      raise "Invalid path #{path}" unless File.exist? path
+      return path if File.file? path
+      source_path = choose_one(path)
+      return source_path unless source_path.nil?
+      raise 'No API Description Document found'
+    end
+
+    def api_description_source(path)
+      source_path = api_description_source_path(path)
+      source = nil
+      File.open(source_path, 'r:bom|utf-8') { |file| source = file.read }
+      source
+    end
+
+    protected
+
+    def choose_one(path)
+      apibPath = api_blueprint(path)
+      swaggerPath = swagger(path)
+
+      if apibPath && swaggerPath
+        warn 'WARNING: Both apiary.apib and swagger.yaml are present. The apiary.apib file will be used. To override this selection specify path to desired file'
+      end
+
+      apibPath || swaggerPath
+    end
+
+    def api_blueprint(path)
+      source_path = File.join(path, 'apiary.apib')
+      return source_path if File.exist? source_path
+      return nil
+    end
+
+    def swagger(path)
+      source_path = File.join(path, 'swagger.yaml')
+      return source_path if File.exist? source_path
+      return nil
+    end
+  end
+end

data/lib/apiary/version.rb

@@ -1,3 +1,3 @@
 module Apiary
-  VERSION = "0.3.5"
+  VERSION = "0.4.1"
 end

data/spec/{cli_spec.rb → apiary/cli_spec.rb}

@@ -38,4 +38,3 @@ describe Apiary::CLI do
     end
   end
 end
-

data/spec/{command → apiary/command}/preview_spec.rb

@@ -4,7 +4,7 @@ describe Apiary::Command::Preview do
 
   let(:command) do
     opts = {
-      path: "#{File.expand_path File.dirname(__FILE__)}/../../features/fixtures/apiary.apib"
+      path: "#{File.expand_path File.dirname(__FILE__)}/../../fixtures/apiary.apib"
     }
     Apiary::Command::Preview.new(opts)
   end

data/spec/{command → apiary/command}/publish_spec.rb

@@ -5,12 +5,13 @@ describe Apiary::Command::Publish do
     let(:message) do
       Apiary::Command::Publish.new({
         :api_name => 'myapi',
-        :path => './features/fixtures/apiary.apib'
+        :path => 'spec/fixtures/apiary.apib',
+        :api_key => 'testkey'
       }).options.message
     end
 
     it 'uses the default message' do
-      expect(message).to eq('Saving blueprint from apiary-client')
+      expect(message).to eq('Saving API Description Document from apiary-client')
     end
   end
 
@@ -19,7 +20,8 @@ describe Apiary::Command::Publish do
       Apiary::Command::Publish.new({
         :api_name => 'myapi',
         :message => 'Custom message',
-        :path => './features/fixtures/apiary.apib'
+        :path => 'spec/fixtures/apiary.apib',
+        :api_key => 'testkey'
       }).options.message
     end
 
@@ -35,7 +37,8 @@ describe Apiary::Command::Publish do
         Apiary::Command::Publish.new({
           :api_name => 'myapi',
           :message => 'Custom message',
-          :path => './features/fixtures/apiary.apib'
+          :path => 'spec/fixtures/apiary.apib',
+          :api_key => 'testkey'
         }).execute
       end
 

data/spec/apiary/helpers_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Apiary::Helpers do
+  include Apiary::Helpers
+
+  describe '#api_description_source_path' do
+    context 'path doesn\'t exists' do
+      it 'should raise error saying that Directory doesn\'t exists' do
+        path = 'spec/fixtures/invalid_path'
+        expect { api_description_source_path(path)}.to raise_error(/Invalid path/)
+      end
+    end
+
+    context 'missing file is in path' do
+      it 'should raise error saying that file doesn\'t exists' do
+        path = 'spec/fixtures/only_api_blueprint/swagger.yaml'
+        expect { api_description_source_path(path)}.to raise_error(/Invalid path/)
+      end
+    end
+
+    context 'directory is in path and contains API Blueprint only' do
+      it 'should return path ending to `apiary.apib`' do
+        path = 'spec/fixtures/only_api_blueprint'
+        expect(api_description_source_path(path)).to match(/apiary\.apib$/)
+      end
+    end
+
+    context 'directory is in path and contains Swagger only' do
+      it 'should return path ending to `swagger.yaml`' do
+        path = 'spec/fixtures/only_swagger'
+        expect(api_description_source_path(path)).to match(/swagger\.yaml$/)
+      end
+    end
+
+    context 'directory is in path and contains both API Blueprint and Swagger' do
+      it 'should prefere API Blueprint and return path ending to `apiary.apib`' do
+        path = 'spec/fixtures/api_blueprint_and_swagger'
+        expect(api_description_source_path(path)).to match(/apiary\.apib$/)
+        expect { api_description_source_path(path) }.to output("WARNING: Both apiary.apib and swagger.yaml are present. The apiary.apib file will be used. To override this selection specify path to desired file\n").to_stderr
+      end
+    end
+
+    context 'empty folder' do
+      it 'should raise error saying that file doesn\'t exists' do
+        path = 'spec/fixtures/empty_folder'
+        expect { api_description_source_path(path)}.to raise_error('No API Description Document found')
+      end
+    end
+
+    context 'existing file is in path' do
+      it 'should return same path as was entered' do
+        path = 'spec/fixtures/only_api_blueprint/apiary.apib'
+        expect(api_description_source_path(path)).to equal(path)
+      end
+    end
+  end
+
+  describe '#api_description_source' do
+    it 'get file with and without BOM' do
+      file1 = api_description_source('spec/fixtures/apiary.apib')
+      file2 = api_description_source('spec/fixtures/apiary_with_bom.apib')
+      expect(file1).not_to be_nil
+      expect(file2).not_to be_nil
+      expect(file1).to eq(file2)
+    end
+  end
+end

data/spec/fixtures/api_blueprint_and_swagger/apiary.apib

@@ -0,0 +1,5 @@
+FORMAT: 1A
+
+# Minimal
+
+Minimal API Blueprint

data/spec/fixtures/api_blueprint_and_swagger/swagger.yaml

@@ -0,0 +1,5 @@
+swagger: "2.0"
+info:
+  version: 1.0.0
+  title: Minimal
+  description: Minimal Swagger