apiaryio 0.4.2 → 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a36c2e7ac9a3e128f7829c1d5ed3be33548d341
+  data.tar.gz: 17c8f132e9f9a61385d19fa17242267537b84b17
+SHA512:
+  metadata.gz: 818e3ec9b05cbf51af887e9626e1b4f39cd3083e0c543cb4a0eac6d004054274e3d0c85bccbc67b104b52110c4ec2caf47a84de8da54f6fdfa1b9022fc30be91
+  data.tar.gz: a500c7a68dc6241c636ad20d7af3a293fb9198e69c52b0b3dcd56389f0847668ed0c9d892ea823c945c3c32f20c0f837389de10f3e5cc5b88a1125eb37d323b6

data/.rubocop_todo.yml

@@ -0,0 +1,42 @@
+Lint/Eval:
+  Exclude:
+    - 'Rakefile'
+
+Lint/UnusedBlockArgument:
+  Exclude:
+    - 'lib/apiary/command/preview.rb'
+
+Metrics/AbcSize:
+  Max: 25
+
+
+Metrics/LineLength:
+  Max: 180
+  Exclude:
+      - 'spec/*'
+      - 'spec/apiary/*'
+      - 'spec/apiary/command/*'
+
+Metrics/MethodLength:
+  Max: 26
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/ClassVars:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+  EnforcedStyle: slashes
+
+Style/UnneededInterpolation:
+  Enabled: false
+
+Style/MutableConstant:
+  Exclude:
+    - 'lib/apiary/helpers/javascript_helper.rb'
+    - 'spec/apiary/command/fetch_spec.rb'

data/README.md

@@ -59,7 +59,7 @@ $ apiary help
 Commands:
   apiary fetch --api-name=API_NAME    # Fetch API Description Document from API_NAME.apiary.io
   apiary help [COMMAND]               # Describe available commands or one specific command
-  apiary preview                      # Show API documentation in default browser
+  apiary preview                      # Show API documentation in browser or write it to file
   apiary publish --api-name=API_NAME  # Publish API Description Document on docs.API_NAME.apiary.io
   apiary version                      # Show version
 
@@ -90,16 +90,15 @@ Usage:
   apiary preview
 
 Options:
-  [--browser=chrome|safari|firefox]  # Show API documentation in specified browser
-                                     # Possible values: chrome, safari, firefox
-  [--output=FILE]                    # Write generated HTML into specified file
-  [--path=PATH]                      # Specify path to API Description Document. When given a directory, it will look for apiary.apib or swagger.yaml file
-  [--api-host=HOST]                  # Specify apiary host
-  [--server], [--no-server]          # Start standalone web server on port 8080
-  [--port=PORT]                      # Set port for --server option
-  [--host=HOST]                      # Set host for --server option
-
-Show API documentation in default browser
+  [--browser=BROWSER]        # Show API documentation in specified browser (full command is needed - e.g. `--browser='open -a safari'` in case of osx)
+  [--output=FILE]            # Write generated HTML into specified file
+  [--path=PATH]              # Specify path to API Description Document. When given a directory, it will look for apiary.apib or swagger.yaml file
+  [--api-host=HOST]          # Specify apiary host
+  [--server], [--no-server]  # Start standalone web server on port 8080
+  [--port=PORT]              # Set port for --server option
+  [--host=HOST]              # Set host for --server option
+
+Show API documentation in browser or write it to file
 ```
 
 #### publish

data/Rakefile

@@ -4,7 +4,7 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+task default: :spec
 
 def gemspec
   @gemspec ||= eval(File.read('apiary.gemspec'), binding, '.gemspec')

data/apiary.gemspec

@@ -5,33 +5,34 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'apiary/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "apiaryio"
+  gem.name          = 'apiaryio'
   gem.version       = Apiary::VERSION
-  gem.authors       = ["Apiary Ltd."]
-  gem.email         = ["team@apiary.io"]
+  gem.authors       = ['Apiary Ltd.']
+  gem.email         = ['team@apiary.io']
 
-  gem.description   = %q{Apiary.io CLI}
-  gem.summary       = %q{Apiary.io CLI}
-  gem.homepage      = "http://apiary.io"
-  gem.license       = "MIT"
+  gem.description   = 'Apiary.io CLI'
+  gem.summary       = 'Apiary.io CLI'
+  gem.homepage      = 'http://apiary.io'
+  gem.license       = 'MIT'
 
-  gem.files         = `git ls-files`.split($\)
-  gem.bindir        = "bin"
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  gem.bindir        = 'bin'
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 
-  gem.add_dependency "rest-client", "~> 1.8"
-  gem.add_dependency "rack", "~> 1.6.4"
-  gem.add_dependency "thor", "~> 0.19.1"
+  gem.add_runtime_dependency 'rest-client', '~> 1.8'
+  gem.add_runtime_dependency 'rack', '~> 1.6.4'
+  gem.add_runtime_dependency 'thor', '~> 0.19.1'
+  gem.add_runtime_dependency 'json', '~> 1.8'
+  gem.add_runtime_dependency 'launchy', '~> 2.4'
 
-  gem.add_runtime_dependency "json", "~> 1.8"
-
-  gem.add_development_dependency "bundler", "~> 1.12"
-  gem.add_development_dependency "rake", "~> 10.0"
-  gem.add_development_dependency "rspec", "~> 3.4"
-  gem.add_development_dependency "webmock", "~> 2.0"
-  gem.add_development_dependency "yard", "~> 0.8"
-  gem.add_development_dependency "aruba", "~> 0.14"
-  gem.add_development_dependency "cucumber", "~> 2.0"
+  gem.add_development_dependency 'bundler', '~> 1.12'
+  gem.add_development_dependency 'rake', '~> 10.0'
+  gem.add_development_dependency 'rspec', '~> 3.4'
+  gem.add_development_dependency 'webmock', '~> 2.0'
+  gem.add_development_dependency 'yard', '~> 0.8'
+  gem.add_development_dependency 'aruba', '~> 0.14'
+  gem.add_development_dependency 'cucumber', '~> 2.0'
+  gem.add_development_dependency 'rubocop', '~> 0.41.2'
 end

data/bin/apiary

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..','lib')))
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
 require 'apiary'
 
 Apiary::CLI.start

data/circle.yml

@@ -1,7 +1,9 @@
 dependencies:
   pre:
     - gem update bundler
+
 test:
   override:
+    - bundle exec rubocop --config .rubocop_todo.yml
     - bundle exec rspec spec
     - bundle exec cucumber

data/features/step_definitions/file_content_step.rb

@@ -1,10 +1,10 @@
-Then /^the output should contain the content of file "(.*)"$/ do |filename|
+Then(/^the output should contain the content of file "(.*)"$/) do |filename|
   expected = nil
   cd('../../spec/fixtures') do
     expected = File.read(filename)
   end
 
-  actual = all_commands.map { |c| c.output }.join("\n")
+  actual = all_commands.map(&:output).join("\n")
 
   expect(unescape_text(actual)).to include(unescape_text(expected))
 end

data/features/support/env.rb

@@ -4,17 +4,17 @@ Before('@needs_apiary_api_key') do
   @aruba_timeout_seconds = 45
 end
 
-Around('@needs_apiary_api_key') do |scenario, block|
+Around('@needs_apiary_api_key') do |_scenario, block|
   # DEBUG puts "Scenario #{scenario.name} wants APIARY_API_KEY."
-  original_value = ENV.delete("APIARY_API_KEY");
-  ENV["APIARY_API_KEY"] = "340bda135034529ab2abf341295c3aa2" # XXX
+  original_value = ENV.delete('APIARY_API_KEY')
+  ENV['APIARY_API_KEY'] = '340bda135034529ab2abf341295c3aa2' # XXX
   block.call
-  ENV["APIARY_API_KEY"] = original_value
+  ENV['APIARY_API_KEY'] = original_value
 end
 
-Around('@doesnt_need_apiary_api_key') do |scenario, block|
+Around('@doesnt_need_apiary_api_key') do |_scenario, block|
   # DEBUG puts "Scenario #{scenario.name} doesn't want APIARY_API_KEY."
-  original_value = ENV.delete("APIARY_API_KEY");
+  original_value = ENV.delete('APIARY_API_KEY')
   block.call
-  ENV["APIARY_API_KEY"] = original_value
+  ENV['APIARY_API_KEY'] = original_value
 end

data/lib/apiary/agent.rb

@@ -1,5 +1,5 @@
 module Apiary
-  USER_AGENT = "apiaryio-gem/#{Apiary::VERSION} (#{RUBY_PLATFORM}) ruby/#{RUBY_VERSION}"
+  USER_AGENT = "apiaryio-gem/#{Apiary::VERSION} (#{RUBY_PLATFORM}) ruby/#{RUBY_VERSION}".freeze
 
   module_function
 

data/lib/apiary/cli.rb

@@ -6,25 +6,24 @@ require 'apiary/command/publish'
 
 module Apiary
   class CLI < Thor
-
     desc 'fetch', 'Fetch API Description Document from API_NAME.apiary.io'
-    method_option :api_name, :type => :string, :required => true
-    method_option :api_host, :type => :string, :banner => 'HOST', :desc => 'Specify apiary host'
-    method_option :output, :type => :string, :banner => 'FILE', :desc => 'Write API Description Document into specified file'
+    method_option :api_name, type: :string, required: true
+    method_option :api_host, type: :string, banner: 'HOST', desc: 'Specify apiary host'
+    method_option :output, type: :string, banner: 'FILE', desc: 'Write API Description Document into specified file'
 
     def fetch
       cmd = Apiary::Command::Fetch.new options
       cmd.execute
     end
 
-    desc 'preview', 'Show API documentation in default browser'
-    method_option :browser, :type => :string, :enum => %w(chrome safari firefox), :banner => 'chrome|safari|firefox', :desc => 'Show API documentation in specified browser'
-    method_option :output, :type => :string, :banner => 'FILE', :desc => 'Write generated HTML into specified file'
-    method_option :path, :type => :string, :desc => 'Specify path to API Description Document. When given a directory, it will look for apiary.apib or swagger.yaml file'
-    method_option :api_host, :type => :string, :banner => 'HOST', :desc => 'Specify apiary host'
-    method_option :server, :type => :boolean, :desc => 'Start standalone web server on port 8080'
-    method_option :port, :type => :numeric, :banner => 'PORT', :desc => 'Set port for --server option'
-    method_option :host, :type => :string, :desc => 'Set host for --server option'
+    desc 'preview', 'Show API documentation in browser or write it to file'
+    method_option :browser, type: :string, desc: 'Show API documentation in specified browser (full command is needed - e.g. `--browser=\'open -a safari\'` in case of osx)'
+    method_option :output, type: :string, banner: 'FILE', desc: 'Write generated HTML into specified file'
+    method_option :path, type: :string, desc: 'Specify path to API Description Document. When given a directory, it will look for apiary.apib or swagger.yaml file'
+    method_option :api_host, type: :string, banner: 'HOST', desc: 'Specify apiary host'
+    method_option :server, type: :boolean, desc: 'Start standalone web server on port 8080'
+    method_option :port, type: :numeric, banner: 'PORT', desc: 'Set port for --server option'
+    method_option :host, type: :string, desc: 'Set host for --server option'
 
     def preview
       cmd = Apiary::Command::Preview.new options
@@ -32,10 +31,10 @@ module Apiary
     end
 
     desc 'publish', 'Publish API Description Document on docs.API_NAME.apiary.io'
-    method_option :message, :type => :string, :banner => 'COMMIT_MESSAGE', :desc => 'Publish with custom commit message'
-    method_option :path, :type => :string, :desc => 'Specify path to API Description Document. When given a directory, it will look for apiary.apib or swagger.yaml file'
-    method_option :api_host, :type => :string, :banner => 'HOST', :desc => 'Specify apiary host'
-    method_option :api_name, :type => :string, :required => true
+    method_option :message, type: :string, banner: 'COMMIT_MESSAGE', desc: 'Publish with custom commit message'
+    method_option :path, type: :string, desc: 'Specify path to API Description Document. When given a directory, it will look for apiary.apib or swagger.yaml file'
+    method_option :api_host, type: :string, banner: 'HOST', desc: 'Specify apiary host'
+    method_option :api_name, type: :string, required: true
 
     def publish
       cmd = Apiary::Command::Publish.new options
@@ -43,7 +42,7 @@ module Apiary
     end
 
     desc 'version', 'Show version'
-    method_option :aliases => "-v"
+    method_option aliases: '-v'
 
     def version
       puts Apiary::VERSION

data/lib/apiary/command/fetch.rb

@@ -9,7 +9,6 @@ require 'apiary/agent'
 module Apiary::Command
   # Retrieve blueprint from apiary
   class Fetch
-
     def initialize(opts)
       @options = OpenStruct.new(opts)
       @options.api_host     ||= 'api.apiary.io'
@@ -17,18 +16,19 @@ module Apiary::Command
       @options.api_key      ||= ENV['APIARY_API_KEY']
       @options.proxy        ||= ENV['http_proxy']
       @options.headers      ||= {
-        :accept => 'text/html',
-        :content_type => 'text/plain',
-        :authentication => "Token #{@options.api_key}",
-        :user_agent => Apiary.user_agent
+        accept: 'text/html',
+        content_type: 'text/plain',
+        authentication: "Token #{@options.api_key}",
+        user_agent: Apiary.user_agent
       }
     end
 
     def execute
       response = fetch_from_apiary
-      if response.instance_of? String
-        puts response
-      end
+
+      return unless response.instance_of? String
+
+      puts response
     end
 
     def fetch_from_apiary

data/lib/apiary/command/preview.rb

@@ -5,120 +5,110 @@ require 'ostruct'
 require 'json'
 require 'tmpdir'
 require 'erb'
+require 'launchy'
 
 require 'apiary/agent'
 require 'apiary/helpers'
 require 'apiary/helpers/javascript_helper'
 
 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"
-
-      BROWSERS = {
-        :safari => 'Safari',
-        :chrome => 'Google Chrome',
-        :firefox => 'Firefox'
+  # 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".freeze
+
+    attr_reader :options
+
+    def initialize(opts)
+      @options = OpenStruct.new(opts)
+      @options.path         ||= '.'
+      @options.api_host     ||= 'api.apiary.io'
+      @options.port         ||= 8080
+      @options.proxy        ||= ENV['http_proxy']
+      @options.server       ||= false
+      @options.host         ||= '127.0.0.1'
+      @options.headers      ||= {
+        accept: 'text/html',
+        content_type: 'text/plain',
+        user_agent: Apiary.user_agent
       }
 
-      attr_reader :options
-
-      def initialize(opts)
-        @options = OpenStruct.new(opts)
-        @options.path         ||= '.'
-        @options.api_host     ||= 'api.apiary.io'
-        @options.port         ||= 8080
-        @options.proxy        ||= ENV['http_proxy']
-        @options.server       ||= false
-        @options.host         ||= '127.0.0.1'
-        @options.headers      ||= {
-          :accept => 'text/html',
-          :content_type => 'text/plain',
-          :user_agent => Apiary.user_agent
-        }
-
-        begin
-          @source_path = api_description_source_path(@options.path)
-        rescue Exception => e
-          abort "#{e.message}"
-        end
+      begin
+        @source_path = api_description_source_path(@options.path)
+      rescue StandardError => e
+        abort "#{e.message}"
       end
+    end
 
-      def execute
-        if @options.server
-          server
-        else
-          show
-        end
+    def execute
+      if @options.server
+        server
+      else
+        show
       end
+    end
 
-      def server
-        app = self.rack_app do
-          generate
-        end
-
-        Rack::Server.start(:Port => @options.port, :Host => @options.host, :app => app)
+    def server
+      app = rack_app do
+        generate
       end
 
-      def show
-        preview_string = generate
+      Rack::Server.start(Port: @options.port, Host: @options.host, app: app)
+    end
 
-        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 show
+      preview_string = generate
 
-      def browser
-        BROWSERS[@options.browser] || nil
+      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 rack_app(&block)
-        Rack::Builder.new do
-          run lambda { |env| [200, Hash.new, [block.call]] }
-        end
+    def rack_app
+      Rack::Builder.new do
+        run ->(env) { [200, {}, [yield]] }
       end
+    end
 
-      # TODO: add linux and windows systems
-      def open_generated_page(path)
-        exec "open #{browser_options} #{path}"
-      end
+    def open_generated_page(path)
+      def_browser = ENV['BROWSER']
+      ENV['BROWSER'] = @options.browser
 
-      def write_generated_path(path, outfile)
-        File.write(outfile, File.read(path))
+      Launchy.open(path) do |e|
+        puts "Attempted to open `#{path}` and failed because #{e}"
       end
+      ENV['BROWSER'] = def_browser
+    end
 
-      def generate
-        template = load_preview_template
+    def write_generated_path(path, outfile)
+      File.write(outfile, File.read(path))
+    end
 
-        data = {
-          title: File.basename(@source_path, '.*'),
-          source: api_description_source(@source_path)
-        }
+    def generate
+      template = load_preview_template
 
-        template.result(binding)
-      end
-
-      def preview_path
-        basename = File.basename(@source_path, '.*')
-        temp = Dir.tmpdir
-        "#{temp}/#{basename}-preview.html"
-      end
+      data = {
+        title: File.basename(@source_path, '.*'),
+        source: api_description_source(@source_path)
+      }
 
-      def load_preview_template
-        file = File.open(PREVIEW_TEMPLATE_PATH, 'r')
-        template_string = file.read
-        ERB.new(template_string)
-      end
+      template.result(binding)
+    end
 
-      private
+    def preview_path
+      basename = File.basename(@source_path, '.*')
+      temp = Dir.tmpdir
+      "#{temp}/#{basename}-preview.html"
+    end
 
-      def browser_options
-        "-a #{BROWSERS[@options.browser.to_sym]}" if @options.browser
-      end
+    def load_preview_template
+      file = File.open(PREVIEW_TEMPLATE_PATH, 'r')
+      template_string = file.read
+      ERB.new(template_string)
     end
+  end
 end

data/lib/apiary/command/publish.rb

@@ -8,80 +8,79 @@ require 'apiary/agent'
 require 'apiary/helpers'
 
 module Apiary::Command
-    # Display preview of local blueprint file
-    class Publish
-      include Apiary::Helpers
+  # Display preview of local blueprint file
+  class Publish
+    include Apiary::Helpers
 
-      attr_reader :options
+    attr_reader :options
 
-      def initialize(opts)
-        @options = OpenStruct.new(opts)
-        @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',
-          :authentication => "Token #{@options.api_key}",
-          :user_agent => Apiary.user_agent
-        }
-        @options.message ||= 'Saving API Description Document from apiary-client'
+    def initialize(opts)
+      @options = OpenStruct.new(opts)
+      @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',
+        authentication: "Token #{@options.api_key}",
+        user_agent: Apiary.user_agent
+      }
+      @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
-        publish_on_apiary
+      begin
+        @source_path = api_description_source_path(@options.path)
+      rescue StandardError => e
+        abort "#{e.message}"
       end
+    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/)'
-        end
+    def execute
+      publish_on_apiary
+    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.'
-        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/)'
+      end
 
-        query_apiary
+      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.'
       end
 
-      def query_apiary
-        url  = "https://#{@options.api_host}/blueprint/publish/#{@options.api_name}"
-        source = api_description_source(@source_path)
+      query_apiary
+    end
 
-        unless source.nil?
-          data = {
-            :code => source,
-            :messageToSave => @options.message
-          }
+    def query_apiary
+      url = "https://#{@options.api_host}/blueprint/publish/#{@options.api_name}"
+      source = api_description_source(@source_path)
 
-          RestClient.proxy = @options.proxy
+      return if source.nil?
+      data = {
+        code: source,
+        messageToSave: @options.message
+      }
 
-          begin
-            RestClient.post url, data, @options.headers
-          rescue RestClient::BadRequest => e
-            err = JSON.parse e.response
-            if err.has_key? 'parserError'
-              abort "#{err['message']}: #{err['parserError']}"
-            else
-              abort "Apiary service responded with an error: #{err['message']}"
-            end
-          rescue RestClient::Exception => e
-            err = JSON.parse e.response
-            if err.has_key? 'message'
-              abort "Apiary service responded with an error: #{err['message']}"
-            else
-              abort "Apiary service responded with an error: #{e.message}"
-            end
-          end
+      RestClient.proxy = @options.proxy
+
+      begin
+        RestClient.post url, data, @options.headers
+      rescue RestClient::BadRequest => e
+        err = JSON.parse e.response
+        if err.key? 'parserError'
+          abort "#{err['message']}: #{err['parserError']}"
+        else
+          abort "Apiary service responded with an error: #{err['message']}"
+        end
+      rescue RestClient::Exception => e
+        err = JSON.parse e.response
+        if err.key? 'message'
+          abort "Apiary service responded with an error: #{err['message']}"
+        else
+          abort "Apiary service responded with an error: #{e.message}"
         end
       end
     end
+  end
 end

data/lib/apiary/helpers.rb

@@ -20,26 +20,26 @@ module Apiary
     protected
 
     def choose_one(path)
-      apibPath = api_blueprint(path)
-      swaggerPath = swagger(path)
+      apib_path = api_blueprint(path)
+      swagger_path = swagger(path)
 
-      if apibPath && swaggerPath
+      if apib_path && swagger_path
         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
+      apib_path || swagger_path
     end
 
     def api_blueprint(path)
       source_path = File.join(path, 'apiary.apib')
       return source_path if File.exist? source_path
-      return nil
+      nil
     end
 
     def swagger(path)
       source_path = File.join(path, 'swagger.yaml')
       return source_path if File.exist? source_path
-      return nil
+      nil
     end
   end
 end

data/lib/apiary/helpers/javascript_helper.rb

@@ -1,29 +1,25 @@
 # encoding: utf-8
-module Apiary
-  module Helpers
-    module JavascriptHelper
-      JS_ESCAPE_MAP = {
-        '\\'    => '\\\\',
-        '</'    => '<\/',
-        "\r\n"  => '\n',
-        "\n"    => '\n',
-        "\r"    => '\n',
-        '"'     => '\\"',
-        "'"     => "\\'"
-      }
+module Apiary::Helpers::JavascriptHelper
+  JS_ESCAPE_MAP = {
+    '\\'    => '\\\\',
+    '</'    => '<\/',
+    "\r\n"  => '\n',
+    "\n"    => '\n',
+    "\r"    => '\n',
+    '"'     => '\\"',
+    "'"     => "\\'"
+  }
 
-      JS_ESCAPE_MAP["\342\200\250".force_encoding(Encoding::UTF_8).encode!] = '&#x2028;'
-      JS_ESCAPE_MAP["\342\200\251".force_encoding(Encoding::UTF_8).encode!] = '&#x2029;'
+  JS_ESCAPE_MAP["\342\200\250".force_encoding(Encoding::UTF_8).encode!] = '&#x2028;'
+  JS_ESCAPE_MAP["\342\200\251".force_encoding(Encoding::UTF_8).encode!] = '&#x2029;'
 
-      def escape_javascript(javascript)
-        if javascript
-          javascript.gsub(/(\\|<\/|\r\n|\342\200\250|\342\200\251|[\n\r"'])/u) {|match| JS_ESCAPE_MAP[match] }
-        else
-          ''
-        end
-      end
-
-      alias_method :j, :escape_javascript
+  def escape_javascript(javascript)
+    if javascript
+      javascript.gsub(/(\\|<\/|\r\n|\342\200\250|\342\200\251|[\n\r"'])/u) { |match| JS_ESCAPE_MAP[match] }
+    else
+      ''
     end
   end
+
+  alias j escape_javascript
 end

data/lib/apiary/version.rb

@@ -1,3 +1,3 @@
 module Apiary
-  VERSION = "0.4.2"
+  VERSION = '0.5.0'.freeze
 end

data/spec/apiary/cli_spec.rb

@@ -1,40 +1,37 @@
 require 'spec_helper'
 
 describe Apiary::CLI do
-
   # Don't let Thor fold or truncate lines
   ENV['THOR_COLUMNS'] = '1000'
 
   # The documentation that ought to match the code
-  READMETEXT = open("README.md") {|f| f.read}
+  READMETEXT = open('README.md', &:read)
 
   it 'has help' do
-    help = open('|ruby bin/apiary help') {|f| f.read}
-    expect(help).to include("Commands:")
+    help = open('|ruby bin/apiary help', &:read)
+    expect(help).to include('Commands:')
     expect(help.lines.count).to be >= 5
   end
 
   it 'has README.md' do
-    expect(READMETEXT).to include("apiary help")
+    expect(READMETEXT).to include('apiary help')
     expect(READMETEXT.lines.count).to be >= 5
   end
 
   # Confirm that all subcommands are documented, verbatim
-  ([""] + (open('|ruby bin/apiary help', 'r') {|f| f.readlines}
-            .map {|l| /^ +apiary /.match(l)?l:nil}
-            .map {|l| /^ *apiary help/.match(l)?nil:l}
+  ([''] + (open('|ruby bin/apiary help', 'r', &:readlines)
+            .map { |l| /^ +apiary / =~ l ? l : nil }
+            .map { |l| /^ *apiary help/ =~ l ? nil : l }
             .compact
-            .map {|l| /^ *apiary ([^ ]*)/.match(l)[1] + " " }
+            .map { |l| /^ *apiary ([^ ]*)/.match(l)[1] + ' ' }
           )
   ).each do |cmd|
-
     it "includes help #{cmd}in README.md" do
-      helptext = open("|ruby bin/apiary help #{cmd}") {|f| f.read}
+      helptext = open("|ruby bin/apiary help #{cmd}", &:read)
 
       expect(helptext).to include("apiary #{cmd.strip}")
       expect(READMETEXT).to include("apiary #{cmd.strip}")
       expect(READMETEXT).to include(helptext)
-
     end
   end
 end

data/spec/apiary/command/fetch_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Apiary::Command::Fetch do
-
   it 'pass command without params' do
     opts = {}
     command = Apiary::Command::Fetch.new(opts)
@@ -9,9 +8,8 @@ describe Apiary::Command::Fetch do
   end
 
   it 'pass command only with api_name', api_key: true do
-
     opts = {
-        :api_name => 'test_api'
+      api_name: 'test_api'
     }
 
     command = Apiary::Command::Fetch.new(opts)
@@ -19,12 +17,11 @@ describe Apiary::Command::Fetch do
   end
 
   it 'check request for fetch to apiary' do
-
-    API_NAME = 'test_api'
+    API_NAME = 'test_api'.freeze
 
     opts = {
-        :api_name => API_NAME,
-        :api_key => '1234567890'
+      api_name: API_NAME,
+      api_key: '1234567890'
     }
     command = Apiary::Command::Fetch.new(opts)
 
@@ -34,7 +31,7 @@ describe Apiary::Command::Fetch do
   "code": "FORMAT: 1A\nHOST: http://www.testing.com\n\n# Notes API test 123\nNotes API is a *short texts saving* service similar to its physical paper presence on your table.\n\n# Group Notes\nNotes related resources of the **Notes API**\n\n## Notes Collection [/notes]\n### List all Notes [GET]\n+ Response 200 (application/json)\n\n        [{\n          \"id\": 1, \"title\": \"Jogging in park\"\n        }, {\n          \"id\": 2, \"title\": \"Pick-up posters from post-office\"\n        }]\n\n### Create a Note [POST]\n+ Request (application/json)\n\n        { \"title\": \"Buy cheese and bread for breakfast.\" }\n\n+ Response 201 (application/json)\n\n        { \"id\": 3, \"title\": \"Buy cheese and bread for breakfast.\" }\n\n## Note [/notes/{id}]\nA single Note object with all its details\n\n+ Parameters\n    + id (required, number, `1`) ... Numeric `id` of the Note to perform action with. Has example value.\n\n### Retrieve a Note [GET]\n+ Response 200 (application/json)\n\n    + Header\n\n            X-My-Header: The Value\n\n    + Body\n\n            { \"id\": 2, \"title\": \"Pick-up posters from post-office\" }\n\n### Remove a Note [DELETE]\n+ Response 204\n"
 }'
 
-    BLUEPRINT_EXAMPLE = %Q{FORMAT: 1A
+    BLUEPRINT_EXAMPLE = %{FORMAT: 1A
 HOST: http://www.testing.com
 
 # Notes API test 123
@@ -83,7 +80,7 @@ A single Note object with all its details
 + Response 204
 }
 
-    stub_request(:get, "https://api.apiary.io/blueprint/get/#{API_NAME}").to_return(:status => 200, :body => BODY_EXAMPLE, :headers => { 'Content-Type' => 'text/plain' })
+    stub_request(:get, "https://api.apiary.io/blueprint/get/#{API_NAME}").to_return(status: 200, body: BODY_EXAMPLE, headers: { 'Content-Type' => 'text/plain' })
     expect(command.fetch_from_apiary).to eq(BLUEPRINT_EXAMPLE)
   end
 end

data/spec/apiary/command/preview_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Apiary::Command::Preview do
-
   let(:command) do
     opts = {
       path: "#{File.expand_path File.dirname(__FILE__)}/../../fixtures/apiary.apib"
@@ -10,15 +9,14 @@ describe Apiary::Command::Preview do
   end
 
   it 'check tmp path if contains filename' do
-    expect(command.preview_path()).to end_with('apiary-preview.html')
+    expect(command.preview_path).to end_with('apiary-preview.html')
   end
 
   it 'shoud contain html5 doctype' do
-    expect(command.generate()).to include('<!DOCTYPE html>')
+    expect(command.generate).to include('<!DOCTYPE html>')
   end
 
   it 'should contain embed javascript' do
-    expect(command.generate()).to include('https://api.apiary.io/seeds/embed.js')
+    expect(command.generate).to include('https://api.apiary.io/seeds/embed.js')
   end
-
 end

data/spec/apiary/command/publish_spec.rb

@@ -3,11 +3,9 @@ require 'spec_helper'
 describe Apiary::Command::Publish do
   context 'when constructed without a message' do
     let(:message) do
-      Apiary::Command::Publish.new({
-        :api_name => 'myapi',
-        :path => 'spec/fixtures/apiary.apib',
-        :api_key => 'testkey'
-      }).options.message
+      Apiary::Command::Publish.new(api_name: 'myapi',
+                                   path: 'spec/fixtures/apiary.apib',
+                                   api_key: 'testkey').options.message
     end
 
     it 'uses the default message' do
@@ -17,12 +15,10 @@ describe Apiary::Command::Publish do
 
   context 'when constructed with a message' do
     let(:message) do
-      Apiary::Command::Publish.new({
-        :api_name => 'myapi',
-        :message => 'Custom message',
-        :path => 'spec/fixtures/apiary.apib',
-        :api_key => 'testkey'
-      }).options.message
+      Apiary::Command::Publish.new(api_name: 'myapi',
+                                   message: 'Custom message',
+                                   path: 'spec/fixtures/apiary.apib',
+                                   api_key: 'testkey').options.message
     end
 
     it 'stores the message in the opts' do
@@ -34,17 +30,15 @@ describe Apiary::Command::Publish do
     context 'when calling with a custom message' do
       before(:all) do
         WebMock.stub_request(:post, 'https://api.apiary.io/blueprint/publish/myapi')
-        Apiary::Command::Publish.new({
-          :api_name => 'myapi',
-          :message => 'Custom message',
-          :path => 'spec/fixtures/apiary.apib',
-          :api_key => 'testkey'
-        }).execute
+        Apiary::Command::Publish.new(api_name: 'myapi',
+                                     message: 'Custom message',
+                                     path: 'spec/fixtures/apiary.apib',
+                                     api_key: 'testkey').execute
       end
 
       it 'sends the message when publishing' do
-        expect(WebMock).to have_requested(:post, 'https://api.apiary.io/blueprint/publish/myapi').
-          with {|request| request.body.include? 'messageToSave=Custom%20message'}
+        expect(WebMock).to have_requested(:post, 'https://api.apiary.io/blueprint/publish/myapi')
+          .with { |request| request.body.include? 'messageToSave=Custom%20message' }
       end
     end
   end

data/spec/apiary/helpers_spec.rb

@@ -7,14 +7,14 @@ describe Apiary::Helpers 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/)
+        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/)
+        expect { api_description_source_path(path) }.to raise_error(/Invalid path/)
       end
     end
 
@@ -43,7 +43,7 @@ describe Apiary::Helpers do
     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')
+        expect { api_description_source_path(path) }.to raise_error('No API Description Document found')
       end
     end
 

data/spec/spec_helper.rb

@@ -1,13 +1,13 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
 if RUBY_VERSION < '1.9.3'
- ::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require File.join(File.dirname(f), File.basename(f, '.rb')) }
+  ::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require File.join(File.dirname(f), File.basename(f, '.rb')) }
 else
- ::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require_relative f }
+  ::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require_relative f }
 end
 
 require 'apiary'
 
 RSpec.configure do |config|
-  config.filter_run_excluding :api_key => true if ENV['APIARY_API_KEY']
+  config.filter_run_excluding api_key: true if ENV['APIARY_API_KEY']
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: apiaryio
 version: !ruby/object:Gem::Version
-  version: 0.4.2
-  prerelease: 
+  version: 0.5.0
 platform: ruby
 authors:
 - Apiary Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-11 00:00:00.000000000 Z
+date: 2016-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,15 +62,27 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -94,7 +97,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -102,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -110,7 +111,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -118,7 +118,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -126,7 +125,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -134,7 +132,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -142,7 +139,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -150,7 +146,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -158,7 +153,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -166,7 +160,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -174,7 +167,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -182,11 +174,24 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.41.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.41.2
 description: Apiary.io CLI
 email:
 - team@apiary.io
@@ -197,6 +202,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .rubocop_todo.yml
 - .travis.yml
 - Dockerfile
 - Gemfile
@@ -243,27 +249,26 @@ files:
 homepage: http://apiary.io
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Apiary.io CLI
 test_files:
 - features/fetch.feature