apiaryio 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 873f63f23317c10660a702e11bc1c489f8708d2a
-  data.tar.gz: 120fd21dde799a164288915e51ccabb95cc98b78
+  metadata.gz: 8af3f62bd027d03f2d329d2201de1aa7e5069ab6
+  data.tar.gz: aa1e12782606fadee2d1f19c24cd443f1dfb68fa
 SHA512:
-  metadata.gz: f6211eed03bb1e8cae4a0d0b50e244073e20a9a08d7008688356788cc2d2eb4c6e6bbe0c0e5955386b7bee804293c46429436131816f7bbbd94d94f4f1d593a1
-  data.tar.gz: 8ce67899902657078debff5e25f0f4de0ddd18cc23a0edf1b1cb0286a9ba8a37080ad7e666e32298c061d9238a3598a225d2c18708630ca8d4ddf32a16c97c2c
+  metadata.gz: 48692656ed1c1e6fad3ae9c0efb8d97952abdd2551f4f854151ba834fdf307ea0a42b9e9fa95777366dd2d56b554c36f8027cf6377d51e5b3cdaea86123e9df8
+  data.tar.gz: ec49c50223316719535052378fac4229675b5a616077d3e7e251b37a3f2bd4fc3c5a8a6bd41a836d2d1b3086478f9c20a79d90fc9952a336e9e1f9608268ea19

data/.rubocop_todo.yml

@@ -7,10 +7,13 @@ Lint/UnusedBlockArgument:
     - 'lib/apiary/command/preview.rb'
 
 Metrics/AbcSize:
-  Max: 30
+  Max: 33
 
 Metrics/PerceivedComplexity:
-  Max: 10
+  Max: 12
+
+Metrics/CyclomaticComplexity:
+  Max: 9
 
 Metrics/LineLength:
   Max: 180
@@ -20,7 +23,7 @@ Metrics/LineLength:
       - 'spec/apiary/command/*'
 
 Metrics/MethodLength:
-  Max: 26
+  Max: 33
 
 Style/ClassAndModuleChildren:
   Enabled: false
@@ -31,6 +34,9 @@ Style/ClassVars:
 Style/Documentation:
   Enabled: false
 
+Lint/HandleExceptions:
+  Enabled: false
+
 Style/RegexpLiteral:
   Enabled: false
   EnforcedStyle: slashes

data/README.md

@@ -93,6 +93,7 @@ Options:
   [--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
+  [--json], [--no-json]      # Specify that Swagger API Description Document is in json format. Document will be converted to yaml before processing
   [--api-host=HOST]          # Specify apiary host
   [--server], [--no-server]  # Start standalone web server on port 8080
   [--port=PORT]              # Set port for --server option
@@ -111,6 +112,7 @@ Usage:
 Options:
   [--message=COMMIT_MESSAGE]  # Publish with custom commit message
   [--path=PATH]               # Specify path to API Description Document. When given a directory, it will look for apiary.apib or swagger.yaml file
+  [--json], [--no-json]       # Specify that Swagger API Description Document is in json format. Document will be converted to yaml before processing
   [--api-host=HOST]           # Specify apiary host
   [--push], [--no-push]       # Push API Description to the GitHub when API Project is associated with GitHub repository in Apiary
                               # Default: true
@@ -160,8 +162,8 @@ Show version
 Inside the `apiary-client` repository directory run:
 
 ```sh
-$ bundle exec rake test
-$ bundle exec rake features
+$ bundle exec rspec spec
+$ bundle exec cucumber
 ```
 
 
@@ -178,7 +180,7 @@ $ rake release
 
 ## License
 
-Copyright 2012-15 (c) Apiary Ltd.
+Copyright 2012-16 (c) Apiary Ltd.
 
 Released under MIT license.
 See [LICENSE](https://raw.githubusercontent.com/apiaryio/apiary-client/master/LICENSE) file for further details.

data/apiary.gemspec

@@ -26,11 +26,12 @@ Gem::Specification.new do |gem|
   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 'public_suffix', '~> 1.4.6'
 
   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 'webmock', '~> 2.2.0'
   gem.add_development_dependency 'yard', '~> 0.8'
   gem.add_development_dependency 'aruba', '~> 0.14'
   gem.add_development_dependency 'cucumber', '~> 2.0'

data/lib/apiary/cli.rb

@@ -20,6 +20,7 @@ module Apiary
     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 :json, type: :boolean, desc: 'Specify that Swagger API Description Document is in json format. Document will be converted to yaml before processing'
     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'
@@ -33,6 +34,7 @@ module Apiary
     desc 'publish', 'Publish API Description Document on docs.API_NAME.apiary.io (API Description must exist on 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 :json, type: :boolean, desc: 'Specify that Swagger API Description Document is in json format. Document will be converted to yaml before processing'
     method_option :api_host, type: :string, banner: 'HOST', desc: 'Specify apiary host'
     method_option :push, type: :boolean, default: true, desc: 'Push API Description to the GitHub when API Project is associated with GitHub repository in Apiary'
     method_option :api_name, type: :string, required: true

data/lib/apiary/command/preview.rb

@@ -28,6 +28,7 @@ module Apiary::Command
       @options.port         ||= 8080
       @options.proxy        ||= ENV['http_proxy']
       @options.server       ||= false
+      @options.json         ||= false
       @options.host         ||= '127.0.0.1'
       @options.headers      ||= {
         accept: 'text/html',
@@ -90,10 +91,20 @@ module Apiary::Command
 
     def generate
       template = load_preview_template
+      source = api_description_source(@source_path)
+
+      return if source.nil?
+
+      begin
+        JSON.parse(source)
+        abort('Did you forget the --json flag') unless @options.json
+      rescue; end
+
+      source = convert_from_json(source) if @options.json
 
       data = {
         title: File.basename(@source_path, '.*'),
-        source: api_description_source(@source_path)
+        source: source
       }
 
       template.result(binding)

data/lib/apiary/command/publish.rb

@@ -17,6 +17,7 @@ module Apiary::Command
     def initialize(opts)
       @options = OpenStruct.new(opts)
       @options.path           ||= '.'
+      @options.json           ||= false
       @options.api_host       ||= 'api.apiary.io'
       @options.api_name       ||= false
       @options.api_key        ||= ENV['APIARY_API_KEY']
@@ -58,6 +59,12 @@ module Apiary::Command
 
       return if source.nil?
 
+      begin
+        JSON.parse(source)
+        abort('Did you forget the --json flag?') unless @options.json
+      rescue; end
+
+      source = convert_from_json(source) if @options.json
       data = {
         code: source,
         messageToSave: @options.message,

data/lib/apiary/helpers.rb

@@ -17,6 +17,12 @@ module Apiary
       source
     end
 
+    def convert_from_json(add)
+      JSON.parse(add).to_yaml
+    rescue JSON::ParserError => e
+      abort "Unable to convert input document to yaml: #{e.message.lines.first}"
+    end
+
     protected
 
     def choose_one(path)

data/lib/apiary/version.rb

@@ -1,3 +1,3 @@
 module Apiary
-  VERSION = '0.5.2'.freeze
+  VERSION = '0.6.0'.freeze
 end

data/spec/apiary/cli_spec.rb

@@ -27,6 +27,7 @@ describe Apiary::CLI do
           )
   ).each do |cmd|
     it "includes help #{cmd}in README.md" do
+      puts cmd
       helptext = open("|ruby bin/apiary help #{cmd}", &:read)
 
       expect(helptext).to include("apiary #{cmd.strip}")

data/spec/apiary/helpers_spec.rb

@@ -64,4 +64,12 @@ describe Apiary::Helpers do
       expect(file1).to eq(file2)
     end
   end
+
+  describe '#convert_from_json' do
+    it 'converts swagger in yaml to swagger to json' do
+      yaml_source = api_description_source('spec/fixtures/api_blueprint_and_swagger/swagger.yaml')
+      json_source = api_description_source('spec/fixtures/api_blueprint_and_swagger/swagger.json')
+      expect(yaml_source).to eq(convert_from_json(json_source))
+    end
+  end
 end

data/spec/fixtures/api_blueprint_and_swagger/swagger.json

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

data/spec/fixtures/api_blueprint_and_swagger/swagger.yaml

@@ -1,4 +1,5 @@
-swagger: "2.0"
+---
+swagger: '2.0'
 info:
   version: 1.0.0
   title: Minimal

data/spec/fixtures/only_swagger/swagger.yaml

@@ -1,4 +1,5 @@
-swagger: "2.0"
+---
+swagger: '2.0'
 info:
   version: 1.0.0
   title: Minimal

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apiaryio
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Apiary Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-17 00:00:00.000000000 Z
+date: 2016-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -80,6 +80,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: public_suffix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.6
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +142,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -235,6 +249,7 @@ files:
 - spec/apiary/command/publish_spec.rb
 - spec/apiary/helpers_spec.rb
 - spec/fixtures/api_blueprint_and_swagger/apiary.apib
+- spec/fixtures/api_blueprint_and_swagger/swagger.json
 - spec/fixtures/api_blueprint_and_swagger/swagger.yaml
 - spec/fixtures/apiary-invalid.apib
 - spec/fixtures/apiary.apib
@@ -283,6 +298,7 @@ test_files:
 - spec/apiary/command/publish_spec.rb
 - spec/apiary/helpers_spec.rb
 - spec/fixtures/api_blueprint_and_swagger/apiary.apib
+- spec/fixtures/api_blueprint_and_swagger/swagger.json
 - spec/fixtures/api_blueprint_and_swagger/swagger.yaml
 - spec/fixtures/apiary-invalid.apib
 - spec/fixtures/apiary.apib