apipie-bindings 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e97dd17fff7daa31bb6b9c3d9c0ce896a8b6a98
-  data.tar.gz: ebb7ed8491df770582786a1d86102088dc7dee5f
+  metadata.gz: a805b89ca19114aead114bef90692bb47509284b
+  data.tar.gz: 07cf88b87738018220613dfad3ff8311375947ed
 SHA512:
-  metadata.gz: be9739179d7a3c68a2fa8f666d5565cb0f154c5996315f24b43a93d2b131ff2ef08b9b5ee3ec9490ba9122d3421d3df8c6b9c2dee2762497ad4471571e7fdd4c
-  data.tar.gz: 4992332d1c150706ccb2757d9bdb32549b96a153706dd58c64d4c15ea1f1a2a4a7719abb86ca6c0b646cdc1d0ce65417102dee79cda19131bf057215be70a533
+  metadata.gz: 6230f046f2ead04118c213a12e0ca24189d45cef2d61eac2cec82fbc95e44906d24acf4a8fd17d758ff34f4cff4ea2592dced3ab4c4005b4bd4d628d722e8c3c
+  data.tar.gz: 0a89ea42ac4b7db3f29e6643f207aa59ea07135509be0afc64b090831eaa4e021d19605890e2f65ed1fc3498945493ea03371714438cad7757750fc7e3f671ef

data/lib/apipie_bindings.rb

@@ -1,4 +1,5 @@
 require 'apipie_bindings/version'
+require 'apipie_bindings/exceptions'
 require 'apipie_bindings/inflector'
 require 'apipie_bindings/indifferent_hash'
 require 'apipie_bindings/api'

data/lib/apipie_bindings/api.rb

@@ -36,6 +36,7 @@ module ApipieBindings
     #   *after* each API request
     # @option config [Object] :logger (Logger.new(STDERR)) custom logger class
     # @param [Hash] options params that are passed to ResClient as-is
+    # @raise [ApipieBindings::ConfigurationError] when no +:uri+ or +:apidoc_cache_dir+ is provided
     # @example connect to a server
     #   ApipieBindings::API.new({:uri => 'http://localhost:3000/',
     #     :username => 'admin', :password => 'changeme',
@@ -44,6 +45,9 @@ module ApipieBindings
     #   ApipieBindings::API.new({:apidoc_cache_dir => 'test/unit/data',
     #     :apidoc_cache_name => 'architecture'})
     def initialize(config, options={})
+      if config[:uri].nil? && config[:apidoc_cache_dir].nil?
+        raise ApipieBindings::ConfigurationError.new('Either :uri or :apidoc_cache_dir needs to be set')
+      end
       @uri = config[:uri]
       @api_version = config[:api_version] || 1
       @apidoc_cache_dir = config[:apidoc_cache_dir] || File.join(Dir.tmpdir, 'apipie_bindings', @uri.tr(':/', '_'))
@@ -98,19 +102,6 @@ module ApipieBindings
       end
     end
 
-    def retrieve_apidoc
-      FileUtils.mkdir_p(@apidoc_cache_dir) unless File.exists?(@apidoc_cache_dir)
-      path = "/apidoc/v#{@api_version}.json"
-      begin
-        response = http_call('get', path, {},
-          {:accept => "application/json"}, {:response => :raw})
-      rescue
-        raise "Could not load data from #{@uri}#{path}"
-      end
-      File.open(apidoc_cache_file, "w") { |f| f.write(response.body) }
-      log.debug "New apidoc loaded from the server"
-      load_apidoc
-    end
 
     def apidoc
       @apidoc = @apidoc || load_apidoc || retrieve_apidoc
@@ -135,6 +126,22 @@ module ApipieBindings
       apidoc[:docs][:resources].keys.map { |res| resource(res) }
     end
 
+
+    # Call an action in the API.
+    # It finds most fitting route based on given parameters
+    # with other attributes neccessary to do an API call.
+    # If in dry_run mode {#initialize} it finds fake response data in examples
+    # or user provided data. At the end when the response format is JSON it
+    # is parsed and returned as ruby objects. If server supports checksum sending
+    # the internal cache with API description is checked and updated if needed
+    # @param [Symbol] resource_name name of the resource
+    # @param [Symbol] action_name name of the action
+    # @param [Hash] params parameters to be send in the request
+    # @param [Hash] headers extra headers to be sent with the request
+    # @param [Hash] options options to influence the how the call is processed
+    #   * *:response* (Symbol) *:raw* - skip parsing JSON in response
+    # @example show user data
+    #   call(:users, :show, :id => 1)
     def call(resource_name, action_name, params={}, headers={}, options={})
       check_cache if @aggressive_cache_checking
       resource = resource(resource_name)
@@ -149,13 +156,22 @@ module ApipieBindings
         headers, options)
     end
 
-
+    # Low level call to the API. Suitable for calling actions not covered by
+    # apipie documentation. For all other cases use {#call}
+    # @param [String] http_method one of +get+, +put+, +post+, +destroy+, +patch+
+    # @param [String] path URL path that should be called
+    # @param [Hash] params parameters to be send in the request
+    # @param [Hash] headers extra headers to be sent with the request
+    # @param [Hash] options options to influence the how the call is processed
+    #   * *:response* (Symbol) *:raw* - skip parsing JSON in response
+    # @example show user data
+    #   http_call('get', '/api/users/1')
     def http_call(http_method, path, params={}, headers={}, options={})
       headers ||= { }
 
       args = [http_method]
       if %w[post put].include?(http_method.to_s)
-        args << params.to_json
+        args << params
       else
         headers[:params] = params if params
       end
@@ -168,7 +184,7 @@ module ApipieBindings
       if dry_run?
         empty_response = ApipieBindings::Example.new('', '', '', 200, '')
         ex = options[:fake_response ] || empty_response
-        response = RestClient::Response.create(ex.response, ex.status, ex.args)
+        response = RestClient::Response.create(ex.response, ex.status, args)
       else
         response = @client[path].send(*args)
         update_cache(response.headers[:apipie_checksum])
@@ -217,6 +233,23 @@ module ApipieBindings
 
     private
 
+    def retrieve_apidoc
+      FileUtils.mkdir_p(@apidoc_cache_dir) unless File.exists?(@apidoc_cache_dir)
+      path = "/apidoc/v#{@api_version}.json"
+      begin
+        response = http_call('get', path, {},
+          {:accept => "application/json"}, {:response => :raw})
+      rescue
+        raise ApipieBindings::DocLoadingError.new(
+          "Could not load data from #{@uri}#{path}\n"\
+          " - is your server down?\n"\
+          " - was rake apipie:cache run when using apipie cache? (typical production settings)")
+      end
+      File.open(apidoc_cache_file, "w") { |f| f.write(response.body) }
+      log.debug "New apidoc loaded from the server"
+      load_apidoc
+    end
+
     def find_match(fakes, resource, action, params)
       resource = fakes[[resource, action]]
       if resource

data/lib/apipie_bindings/exceptions.rb

@@ -0,0 +1,6 @@
+module ApipieBindings
+
+  class ConfigurationError < StandardError; end
+  class DocLoadingError < StandardError; end
+
+end

data/lib/apipie_bindings/version.rb

@@ -1,5 +1,5 @@
 module ApipieBindings
   def self.version
-    @version ||= Gem::Version.new '0.0.4'
+    @version ||= Gem::Version.new '0.0.5'
   end
 end

data/test/unit/api_test.rb

@@ -59,6 +59,16 @@ describe ApipieBindings::API do
     result.must_be_kind_of Array
   end
 
+  it "should preserve file in args (#2)" do
+    api = ApipieBindings::API.new({
+      :apidoc_cache_dir => 'test/unit/data',
+      :apidoc_cache_name => 'architecture',
+      :dry_run => true})
+    s = StringIO.new; s << 'foo'
+    RestClient::Response.expects(:create).with('', 200, [:post, {:file => s}, {}])
+    result = api.http_call(:post, '/api/path', {:file => s}, {}, {:response => :raw})
+  end
+
   context "update_cache" do
 
     before :each do
@@ -106,4 +116,10 @@ describe ApipieBindings::API do
     end
   end
 
+  context "configuration" do
+    it "should complain when no uri or cache dir is set" do
+      proc {ApipieBindings::API.new({})}.must_raise ApipieBindings::ConfigurationError
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apipie-bindings
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Martin Bačovský
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-18 00:00:00.000000000 Z
+date: 2014-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -52,20 +52,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: i18n
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +95,7 @@ files:
 - lib/apipie_bindings/action.rb
 - lib/apipie_bindings/api.rb
 - lib/apipie_bindings/example.rb
+- lib/apipie_bindings/exceptions.rb
 - lib/apipie_bindings/indifferent_hash.rb
 - lib/apipie_bindings/inflector.rb
 - lib/apipie_bindings/param.rb