apiaryio 0.3.5 → 0.4.1

data/.gitignore

@@ -8,6 +8,7 @@
 /test/tmp/
 /test/version_tmp/
 /tmp/
+/vendor
 
 ## Specific to RubyMotion:
 .dat*
@@ -33,5 +34,5 @@ Gemfile.lock
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
 
-# testing 
-features/fixtures/test.html
+# testing
+spec/fixtures/test.html

data/.travis.yml

@@ -12,14 +12,6 @@ matrix:
 cache: bundler
 before_install:
   - gem update bundler
-matrix:
-  allow_failures:
-    - rvm: rbx-2
-cache: bundler
-notifications:
-  hipchat:
-    rooms:
-      secure: "HqBUrmf4P2bgvwb4b9PL1tBae2wcZaXadOgwRwAFhdhDZFHaKXIXlJRUW8tN\ntdO83OZgatxJrpWWQj8VYTfDuhlE3b3NxVWeXc3PkfrHmuvejQf4veh7kwR0\njLVE6jb+ZbFIwRE2W0VFLFKYQHI6PLem4W0OKXW5Shqzy8Ewlow="
-    template:
-      - '%{repository}#%{build_number} (%{branch} - %{commit} : %{author}): %{message} (<a href="%{build_url}">Details</a>/<a href="%{compare_url}">Change view</a>)'
-    format: html
+script:
+  - bundle exec rspec spec
+  - bundle exec cucumber

data/README.md

@@ -57,10 +57,10 @@ export APIARY_API_KEY=<your_token>
 ```
 $ apiary help
 Commands:
-  apiary fetch --api-name=API_NAME    # Fetch apiary.apib from API_NAME.apiary.io
+  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 publish --api-name=API_NAME  # Publish apiary.apib on docs.API_NAME.apiary.io
+  apiary publish --api-name=API_NAME  # Publish API Description Document on docs.API_NAME.apiary.io
   apiary version                      # Show version
 
 ```
@@ -77,9 +77,9 @@ Usage:
 Options:
   --api-name=API_NAME  
   [--api-host=HOST]    # Specify apiary host
-  [--output=FILE]      # Write apiary.apib into specified file
+  [--output=FILE]      # Write API Description Document into specified file
 
-Fetch apiary.apib from API_NAME.apiary.io
+Fetch API Description Document from API_NAME.apiary.io
 ```
 
 #### preview
@@ -93,8 +93,7 @@ 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 blueprint file
-                                     # Default: apiary.apib
+  [--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
@@ -112,12 +111,11 @@ Usage:
 
 Options:
   [--message=COMMIT_MESSAGE]  # Publish with custom commit message
-  [--path=PATH]               # Specify path to blueprint file
-                              # Default: apiary.apib
+  [--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
   --api-name=API_NAME         
 
-Publish apiary.apib on docs.API_NAME.apiary.io
+Publish API Description Document on docs.API_NAME.apiary.io
 ```
 
 #### version
@@ -183,4 +181,3 @@ Copyright 2012-15 (c) Apiary Ltd.
 
 Released under MIT license.
 See [LICENSE](https://raw.githubusercontent.com/apiaryio/apiary-client/master/LICENSE) file for further details.
-

data/Rakefile

@@ -1,41 +1,16 @@
 # encoding: utf-8
-require "rubygems"
-require "rspec/core/rake_task"
-require 'yard'
-require 'cucumber'
-require 'cucumber/rake/task'
-begin
-      require 'bundler/gem_tasks'
-rescue LoadError
-      puts "Cannot load bundler/gem_tasks"
-end
-
-desc "Run all features"
-Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = "features --format pretty"
-end
 
-desc "Run all specs"
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.fail_on_error = false
-  t.verbose = true
-end
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-desc 'Default: Run all specs.'
+RSpec::Core::RakeTask.new(:spec)
 task :default => :spec
 
-task :test => :spec
-
-task :doc => :yard
-task :gem => :gemspec
-
 def gemspec
   @gemspec ||= eval(File.read('apiary.gemspec'), binding, '.gemspec')
 end
 
-YARD::Rake::YardocTask.new
-
-desc "Validate the gemspec"
+desc 'Validate the gemspec'
 task :gemspec do
   gemspec.validate
 end

data/apiary.gemspec

@@ -1,31 +1,37 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/apiary/version', __FILE__)
+# encoding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apiary/version'
 
 Gem::Specification.new do |gem|
+  gem.name          = "apiaryio"
+  gem.version       = Apiary::VERSION
   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.files         = `git ls-files`.split($\)
+  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.name          = "apiaryio"
   gem.require_paths = ["lib"]
-  gem.version       = Apiary::VERSION
 
   gem.add_dependency "rest-client", "~> 1.8"
   gem.add_dependency "rack", "~> 1.6.4"
-  gem.add_dependency "rake", "~> 10.4"
   gem.add_dependency "thor", "~> 0.19.1"
 
   gem.add_runtime_dependency "json", "~> 1.8"
 
-  gem.add_development_dependency "rspec", "~> 3.2.0"
-  gem.add_development_dependency "webmock", "~> 1.20"
+  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.6.2", "< 0.7.0"
-  gem.add_development_dependency "cucumber", "~> 1.3", '>= 1.3.19'
+  gem.add_development_dependency "aruba", "~> 0.14"
+  gem.add_development_dependency "cucumber", "~> 2.0"
 end

data/appveyor.yml

@@ -1,22 +1,31 @@
 ---
-version: "{build}"
+version: "{branch}-{build}"
+
 clone_depth: 10
+
+build: off
+
 install:
-  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
+  - gem update bundler
+  - bundle config --local path vendor/bundle
+  - bundle install
+
+before_test:
   - ruby --version
   - gem --version
-  - gem install bundler --quiet --no-ri --no-rdoc
   - bundler --version
-build_script:
-  - bundle install
+
 test_script:
-  - rake test
+  - bundle exec rspec spec
+
 artifacts:
   - path: pkg\*.gem
+
+cache:
+  - vendor/bundle
+
 environment:
   matrix:
-    - ruby_version: "193"
-    - ruby_version: "200"
-    - ruby_version: "200-x64"
-    - ruby_version: "21"
-    - ruby_version: "21-x64"
+    - ruby_version: 193
+    - ruby_version: 22

data/bin/apiary

@@ -2,5 +2,4 @@
 $:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..','lib')))
 require 'apiary'
 
-Apiary::CLI.new(ARGV)
-
+Apiary::CLI.start

data/circle.yml

@@ -3,5 +3,5 @@ dependencies:
     - gem update bundler
 test:
   override:
-    - bundle exec rake test
-    - bundle exec rake features
+    - bundle exec rspec spec
+    - bundle exec cucumber

data/features/preview.feature

@@ -4,5 +4,5 @@ Feature: Show API documentation in specified browser
   @needs_apiary_api_key
   Scenario: Write generated HTML into specified file
 
-    When I run `apiary preview --path apiary.apib --output=test.html`
+    When I run `apiary preview --path ../../spec/fixtures/apiary.apib --output=test.html`
     Then a file named "test.html" should exist

data/features/step_definitions/file_content_step.rb

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

data/features/support/env.rb

@@ -1,9 +1,7 @@
 require 'aruba/cucumber'
-require 'fileutils'
 
-Before do
-  @dirs << "../../features/fixtures"
-  ENV['PATH'] = "./bin#{File::PATH_SEPARATOR}#{ENV['PATH']}"  
+Before('@needs_apiary_api_key') do
+  @aruba_timeout_seconds = 45
 end
 
 Around('@needs_apiary_api_key') do |scenario, block|

data/lib/apiary.rb

@@ -1,7 +1,5 @@
-require 'rubygems'
 require 'apiary/version'
 require 'apiary/cli'
-require 'apiary/common'
 
 module Apiary
 end

data/lib/apiary/agent.rb

@@ -0,0 +1,13 @@
+module Apiary
+  USER_AGENT = "apiaryio-gem/#{Apiary::VERSION} (#{RUBY_PLATFORM}) ruby/#{RUBY_VERSION}"
+
+  module_function
+
+  def user_agent
+    @@user_agent ||= USER_AGENT
+  end
+
+  def user_agent=(agent)
+    @@user_agent = agent
+  end
+end

data/lib/apiary/cli.rb

@@ -7,10 +7,10 @@ require 'apiary/command/publish'
 module Apiary
   class CLI < Thor
 
-    desc 'fetch', 'Fetch apiary.apib from API_NAME.apiary.io'
+    desc 'fetch', 'Fetch API Description Document from API_NAME.apiary.io'
     method_option :api_name, :type => :string, :required => true, :default => ''
     method_option :api_host, :type => :string, :banner => 'HOST', :desc => 'Specify apiary host'
-    method_option :output, :type => :string, :banner => 'FILE', :desc => 'Write apiary.apib into specified file'
+    method_option :output, :type => :string, :banner => 'FILE', :desc => 'Write API Description Document into specified file'
 
     def fetch
       cmd = Apiary::Command::Fetch.new options
@@ -20,7 +20,7 @@ module Apiary
     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 blueprint file', :default => 'apiary.apib'
+    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'
@@ -31,9 +31,9 @@ module Apiary
       cmd.execute
     end
 
-    desc 'publish', 'Publish apiary.apib on docs.API_NAME.apiary.io'
+    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 blueprint file', :default => 'apiary.apib'
+    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, :default => ''
 
@@ -50,5 +50,3 @@ module Apiary
     end
   end
 end
-
-Apiary::CLI.start(ARGV)

data/lib/apiary/command/fetch.rb

@@ -4,79 +4,67 @@ require 'rack'
 require 'ostruct'
 require 'json'
 
-module Apiary
-  module Command
-    # Retrieve blueprint from apiary
-    class Fetch
-      attr_reader :options
+require 'apiary/agent'
 
-      # TODO: use OpenStruct to store @options
-      def initialize(opts)
-        @options = OpenStruct.new(opts)
-        @options.path         ||= "apiary.apib"
-        @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 Client Gem (https://help.apiary.io/tools/apiary-cli/)"
-        }
-      end
-
-      def execute()
-        response = fetch_from_apiary
-        if response.instance_of? String
-          puts response
-        end
-      end
+module Apiary::Command
+  # Retrieve blueprint from apiary
+  class Fetch
 
-      def fetch_from_apiary
-        unless @options.api_name
-          abort "Please provide an api-name option (subdomain part from your http://docs.<api-name>.apiary.io/)"
-        end
+    def initialize(opts)
+      @options = OpenStruct.new(opts)
+      @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
+      }
+    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 execute
+      response = fetch_from_apiary
+      if response.instance_of? String
+        puts response
+      end
+    end
 
-        response = self.query_apiary(@options.api_host, @options.path)
-        if @options.output
-          write_generated_path(response["code"], @options.output)
-        else
-          response["code"]
-        end
+    def fetch_from_apiary
+      unless @options.api_name
+        abort 'Please provide an api-name option (subdomain part from your http://docs.<api-name>.apiary.io/)'
       end
 
-      def path
-        @options.path || "#{File.basename(Dir.pwd)}.apib"
+      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(host, path)
-        url  = "https://#{host}/blueprint/get/#{@options.api_name}"
-        RestClient.proxy = @options.proxy
+      response = query_apiary
 
-        begin
-          response = RestClient.get url, @options.headers
-        rescue RestClient::Exception => e
-          abort "Apiary service responded with an error: #{e.message}"
-        end      
-        JSON.parse response.body
+      if @options.output
+        write_generated_path(response['code'], @options.output)
+      else
+        response['code']
       end
+    end
 
-      def write_generated_path(data, outfile)
-        File.open(outfile, 'w') do |file|
-          file.write(data)
-        end
-      end
+    def query_apiary
+      url = "https://#{@options.api_host}/blueprint/get/#{@options.api_name}"
+      RestClient.proxy = @options.proxy
 
-      private
-        def api_name
-          "-a"
-        end
+      begin
+        response = RestClient.get url, @options.headers
+      rescue RestClient::Exception => e
+        abort "Apiary service responded with an error: #{e.message}"
+      end
+      JSON.parse response.body
+    end
 
+    def write_generated_path(data, outfile)
+      File.open(outfile, 'w') do |file|
+        file.write(data)
+      end
     end
   end
 end