geekier_factory 0.0.1 → 0.1.0

data/README.md

@@ -1,4 +1,52 @@
-geekier_factory_gem
-===================
+#Synopsis
 
-Ruby gem for using APIs, based on their Geekier API descriptions.
+Ruby gem for using APIs, based on their Geekier API descriptions.
+
+#Installation
+
+##Gemfile
+
+`gem "geekier_factory"`
+
+##Standalone
+
+`gem install geekier_factory`
+
+#Usage
+
+Download the API definition you want to use.
+
+    require 'geekier_factory'
+    
+    # instanciate the api
+    api = GeekierFactory.factorize('path/to/definition_file.json')
+    
+    # get a list of actions you can perform
+    api.available_actions
+    
+    # select the action you want to perform
+    action = api.available_actions[3]
+    
+    # check out what parameters are possible/necessary
+    action.params
+    
+    # select an action and call it with its parameters
+    action.call(:param1 => 'valueA', :param2 => 'valueB)
+
+And that's how you do it.
+
+#Participate
+
+* fork && commit && send\_pull\_request
+* add [more API definitions](https://github.com/rulesio/geekier)
+* join the [Geekier Google group](https://groups.google.com/d/forum/geekier-apis)
+
+#TODO
+
+(in no particular order)
+
+* Implement support for resources
+* Parameter validations
+* Support for Authentication/API level configuration 
+* Add more descriptions
+* Setup with all the cool testing and dependency checking solutions out there

data/lib/geekier_factory/action.rb

@@ -67,13 +67,15 @@ module GeekierFactory
     Retry = Class.new(Exception)
     ConnectionException = Class.new(Exception)
     def handle_response!(response)
-      if @structure['errorResponses'].map{ |er| er['code'] }.include? response.status
+      if (@structure['errorResponses'] + @api.error_responses).map{ |er| er['code'] }.include? response.status
         ex = @structure['errorResponses'].select{ |er| er['code'] == response.status }
-        if ex['retry'] == true && (@retries ||= 0) < ex[  ]
+        if ex['retry'] == true && (@retries ||= 0) < ex['retry']
           @retries += 1
           raise Retry.new
         else
-          raise ConnectionException.new("#{ex[:reason]} (HTTP status code #{ex[:code]})")
+          message = "#{ex[:reason]} (HTTP status code #{ex[:code]})"
+          message = message + "\n\n" + response[:body] if ex['details'] && ex['details'] == 'body'
+          raise ConnectionException.new(message)
         end
       elsif !response.success?
         raise ConnectionException.new

data/lib/geekier_factory/api.rb

@@ -6,7 +6,7 @@ module GeekierFactory
   class API
     def initialize(structure)
       @structure = structure
-      @actions = @structure['apis'].map{ |api| api['operations'].map{ |op| Action.new(self, op.merge('path' => api['path'])) } }.flatten
+      @actions = Hash[@structure['apis'].map{ |api| [api['description'], api['operations'].map{ |op| Action.new(self, op.merge('path' => api['path'])) }] }]
     end
 
     def log_body?
@@ -34,6 +34,10 @@ module GeekierFactory
     def base_url
       @structure['basePath'].end_with?('/') ? @structure['basePath'] : (@structure['basePath'] + '/')
     end
+    
+    def error_responses
+      @structure['errorResponses'] || []
+    end
 
     # def oauth?
     #   true

data/lib/geekier_factory/version.rb

@@ -1,3 +1,3 @@
 module GeekierFactory
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/test/mock_definition.json

@@ -48,6 +48,8 @@
             "path": "/action.do"
         }
     ], 
+    "errorResponses": [
+    ], 
     "basePath": "http://localhost/api/v0.1",
     "resourcePath": "", 
     "swaggerVersion": "1.1"

data/test/test_factory.rb

@@ -6,7 +6,7 @@ class TestFactory < Test::Unit::TestCase
   
   setup do
     @api = GeekierFactory.factorize(File.join(File.dirname(File.expand_path(__FILE__)), 'mock_definition.json'))
-    @action = @api.available_actions.first
+    @action = @api.available_actions["test api"].first
   end
 
   test "api should be factorized" do
@@ -14,8 +14,10 @@ class TestFactory < Test::Unit::TestCase
     assert @api.is_a? GeekierFactory::API
   end
 
-  test "api should have one action" do
+  test "api should have one operation with action" do
     assert_equal 1, @api.available_actions.size
+    assert @api.available_actions.is_a? Hash
+    assert_equal 1, @api.available_actions["test api"].size
   end
 
   test "action should have 4 parameters" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geekier_factory
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-28 00:00:00.000000000 Z
+date: 2013-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -180,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Generate API objects from swagger definition files