apiaryio 0.2.0 → 0.2.1

data/.travis.yml

@@ -1,15 +1,21 @@
 language: ruby
 rvm:
-  - "1.9.2"
   - "1.9.3"
   - "2.0.0"
-  - "2.1.0"
   - "2.1.1"
   - "jruby-19mode"  # JRuby in 1.9 mode
   - "rbx-2"
 
+matrix:
+  allow_failures:
+    - rvm: rbx-2
+cache: bundler
+before_install:
+  - gem update bundler
+matrix:
+  allow_failures:
+    - rvm: rbx-2
 cache: bundler
-
 notifications:
   email:
     recipients:

data/README.md

@@ -47,7 +47,7 @@ machine, either using static files or using a standalone web server...
       publish --api-name [API_NAME] \
               --message [COMMIT_MESSAGE]          Publish with custom commit message
       fetch   --api-name [API_NAME]               Fetch apiary.apib from API_NAME.apiary.io
-
+              --output [FILE]                     Write apiary.apib into specified file
       help                                        Show this help
       version                                     Show version
 

data/Rakefile

@@ -4,6 +4,11 @@ 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
 
 Cucumber::Rake::Task.new(:features) do |t|
   t.cucumber_opts = "features --format pretty"

data/apiary.gemspec

@@ -18,8 +18,11 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "rest-client", "~> 1.6.7"
   gem.add_dependency "rack", ">= 1.4.0", "< 1.6.0"
-  gem.add_dependency "rake"
-  gem.add_dependency "thor"
+  gem.add_dependency "rake", "~> 10.3.2"
+  gem.add_dependency "thor", "~> 0.19.1"
+  gem.add_dependency "redsnow", "~> 0.2.0"
+
+  gem.add_runtime_dependency "json", "~> 1.8.1"
 
   gem.add_development_dependency "rspec", "~> 3.1.0"
   gem.add_development_dependency "webmock"

data/circle.yml

@@ -1,3 +1,6 @@
+dependencies:
+  pre:
+    - gem update bundler
 test:
   override:
     - bundle exec rake test

data/features/fixtures/apiary-invalid.apib

@@ -0,0 +1,48 @@
+FORMAT: 1A
+
+#    Apiary Client Test
+
+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
+
+{ "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

data/lib/apiary.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require "apiary/version"
 require "apiary/cli"
+require "apiary/common"
 Dir["#{File.dirname(__FILE__)}/apiary/command/*.rb"].each { |f| require(f) }
 
 module Apiary

data/lib/apiary/cli.rb

@@ -9,6 +9,8 @@ module Apiary
 
     desc "fetch", "Fetch apiary.apib 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"
 
     def fetch
       cmd = Apiary::Command::Fetch.new options

data/lib/apiary/command/preview.rb

@@ -4,6 +4,8 @@ require 'rack'
 require 'ostruct'
 require 'json'
 
+require "apiary/common"
+
 module Apiary
   module Command
     # Display preview of local blueprint file
@@ -17,9 +19,7 @@ module Apiary
 
       attr_reader :options
 
-      # TODO: use OpenStruct to store @options
       def initialize(opts)
-        puts opts
         @options = OpenStruct.new(opts)
         @options.path         ||= "apiary.apib"
         @options.api_host     ||= "api.apiary.io"
@@ -46,9 +46,8 @@ module Apiary
       end
 
       def validate_apib_file(apib_file)
-        unless File.exist?(apib_file)
-          abort "Apiary definition file hasn't been found: #{apib_file.inspect}"
-        end
+        common = Apiary::Common.new
+        common.validate_apib_file(apib_file)
       end
 
       def path
@@ -80,25 +79,29 @@ module Apiary
 
       def query_apiary(host, path)
         url  = "https://#{host}/blueprint/generate"
-        begin
-          data = File.read(path)
-        rescue
-          abort "File #{path} not found."
-        end
-
-        RestClient.proxy = @options.proxy
+        if validate_apib_file(path)
+          begin
+            data = File.read(path)
+          rescue
+            abort "File #{path} not found."
+          end
 
-        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']} (Line: #{err['line']}, Column: #{err['column']})"
-          else
-            abort "Apiary service responded with an error: #{err['message']}"
+          RestClient.proxy = @options.proxy
+
+          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']} (Line: #{err['line']}, Column: #{err['column']})"
+            else
+              abort "Apiary service responded with an error: #{err['message']}"
+            end
+          rescue RestClient::Exception => e
+            abort "Apiary service responded with an error: #{e.message}"
           end
-        rescue RestClient::Exception => e
-          abort "Apiary service responded with an error: #{e.message}"
+        else
+          abort "Sorry, Apiary can't display invalid blueprint."
         end
       end
 
@@ -108,9 +111,7 @@ module Apiary
       end
 
       def write_generated_path(path, outfile)
-        File.open(outfile, 'w') do |file|
-          file.write(File.open(path, 'r').read)
-        end
+        File.write(outfile, File.read(path))
       end
 
       def generate_static(path)

data/lib/apiary/command/publish.rb

@@ -3,6 +3,7 @@ require 'rest_client'
 require 'rack'
 require 'ostruct'
 require 'json'
+require "apiary/common"
 
 module Apiary
   module Command
@@ -11,7 +12,6 @@ module Apiary
 
       attr_reader :options
 
-      # TODO: use OpenStruct to store @options
       def initialize(opts)
         @options = OpenStruct.new(opts)
         @options.path           ||= "apiary.apib"
@@ -46,9 +46,8 @@ module Apiary
       end
 
       def validate_apib_file(apib_file)
-        unless File.exist?(apib_file)
-          abort "Apiary definition file hasn't been found: #{apib_file.inspect}"
-        end
+        common = Apiary::Common.new
+        common.validate_apib_file(apib_file)
       end
 
       def path
@@ -57,24 +56,25 @@ module Apiary
 
       def query_apiary(host, path)
         url  = "https://#{host}/blueprint/publish/#{@options.api_name}"
-        validate_apib_file path
-        data = {
-          :code => File.read(path),
-          :messageToSave => @options.commit_message
-        }
-        RestClient.proxy = @options.proxy
+        if validate_apib_file path
+          data = {
+            :code => File.read(path),
+            :messageToSave => @options.commit_message
+          }
+          RestClient.proxy = @options.proxy
 
-        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']}"
+          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
+            abort "Apiary service responded with an error: #{e.message}"
           end
-        rescue RestClient::Exception => e
-          abort "Apiary service responded with an error: #{e.message}"
         end
       end
 

data/lib/apiary/common.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+require 'redsnow'
+
+module Apiary
+    # Common function used in commands
+    class Common
+
+      attr_accessor :error_message
+
+      def initialize()
+      end
+
+      def validate_blueprint(code)
+        result = RedSnow.parse(code)
+        if result.error[:code] == 0
+          @error_message = nil
+          return true
+        else
+          @error_message = result.error[:message]
+          puts "Blueprint validation error: #{@error_message}"
+          return false
+        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
+        code = File.read(apib_file)
+        return validate_blueprint(code)
+      end
+
+    end
+end

data/lib/apiary/version.rb

@@ -1,3 +1,3 @@
 module Apiary
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/common_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Apiary::Common do
+
+  describe 'Validate apib files' do
+
+    it 'test existing file' do
+      common = Apiary::Common.new
+      expect(common.validate_apib_file('features/fixtures/apiary.apib')).to be_truthy
+    end
+
+    it 'test non existing file' do
+      common = Apiary::Common.new
+      expect {common.validate_apib_file('features/fixtures/apiary.xxx')}.to raise_error(/file hasn't been found/)
+    end
+
+  end
+
+  describe 'Validate blueprint' do
+
+    it 'test validate blueprint' do
+      common = Apiary::Common.new
+      expect(common.validate_blueprint('# API_NAME')).to be_truthy
+    end
+
+    it 'test invalidate blueprint' do
+      common = Apiary::Common.new
+      expect(common.validate_blueprint("\t# API_NAME\t\r\n## Group Name")).to be_falsey
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apiaryio
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-29 00:00:00.000000000 Z
+date: 2014-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -54,33 +54,65 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.3.2
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.19.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: redsnow
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -180,6 +212,7 @@ files:
 - bin/apiary
 - circle.yml
 - features/fetch.feature
+- features/fixtures/apiary-invalid.apib
 - features/fixtures/apiary.apib
 - features/preview.feature
 - features/publish.feature
@@ -192,9 +225,11 @@ files:
 - lib/apiary/command/fetch.rb
 - lib/apiary/command/preview.rb
 - lib/apiary/command/publish.rb
+- lib/apiary/common.rb
 - lib/apiary/version.rb
 - spec/cli_spec.rb
 - spec/command/fetch_spec.rb
+- spec/common_spec.rb
 - spec/spec_helper.rb
 - spec/support/aruba.rb
 homepage: http://apiary.io
@@ -210,12 +245,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1564942254574113745
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1564942254574113745
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -224,6 +265,7 @@ specification_version: 3
 summary: Apiary.io CLI
 test_files:
 - features/fetch.feature
+- features/fixtures/apiary-invalid.apib
 - features/fixtures/apiary.apib
 - features/preview.feature
 - features/publish.feature
@@ -233,6 +275,7 @@ test_files:
 - features/version.feature
 - spec/cli_spec.rb
 - spec/command/fetch_spec.rb
+- spec/common_spec.rb
 - spec/spec_helper.rb
 - spec/support/aruba.rb
 has_rdoc: