apipie-bindings 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5699ff9f351b5d069a6426915b9a4c1673ca7318
-  data.tar.gz: caa65d9c3c386c307085446315c4b21656fd352e
+  metadata.gz: 9fbf9178dc6e7698d91a6a0d9f57bb3ca00e6b40
+  data.tar.gz: 7ede66362f69586d304590dd6c449bc4fe5e5f26
 SHA512:
-  metadata.gz: 7f455309fb404431fdb24355d3e29f5649fb4f2b56295a728964a8c57cb8e56e7e47513d8775d68a8f45b67c386e597c4efaf504dac7a6a313be4d07e6417d54
-  data.tar.gz: c44b832e460b910b97ece3376e69e2037594d8cf3521c7dffc37ff78dbf3a2b804bd15c5cb51c94006f6e9a4f8c1d095809ee6575e93430fb6cbcaa94ba93fcc
+  metadata.gz: 25ba2db8f6dcae59ca171a0309fccca7a1bfb8978dfac0a860d62a5c33e4f62c65cbedd6c0b98d6d79da37196fd10beefb941d69ee26860a6dd9e50fd85008ed
+  data.tar.gz: 11194189f412fc4627b2d61abd9472f2a2543c56889c27c99d6c2dc91a92840f1bcfe4789c0f79e117cf4825bc01aba11ca721d47a06895fa7975979f23e78d4

data/lib/apipie_bindings/api.rb

@@ -9,7 +9,7 @@ module ApipieBindings
 
   class API
 
-    attr_reader :apidoc_cache_name, :fake_responses
+    attr_reader :apidoc_cache_name, :fake_responses, :language
     attr_writer :dry_run
 
     # Creates new API bindings instance
@@ -23,7 +23,8 @@ module ApipieBindings
     #   * *:options* (Hash) options passed to OAuth
     # @option config [Hash] :headers additional headers to send with the requests
     # @option config [String] :api_version ('1') version of the API
-    # @option config [String] :apidoc_cache_dir ('/tmp/apipie_bindings/<URI>') where
+    # @option config [String] :language prefered locale for the API description
+    # @option config [String] :apidoc_cache_dir ('~/.cache/apipie_bindings/<URI>') where
     #   to cache the JSON description of the API
     # @option config [String] :apidoc_cache_name ('default.json') name of te cache file.
     #   If there is cache in the :apidoc_cache_dir, it is used.
@@ -51,12 +52,12 @@ module ApipieBindings
       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(':/', '_'))
+      @language = config[:language]
+      @apidoc_cache_dir = config[:apidoc_cache_dir] || File.join(File.expand_path('~/.cache'), 'apipie_bindings', @uri.tr(':/', '_'))
       @apidoc_cache_name = config[:apidoc_cache_name] || set_default_name
       @dry_run = config[:dry_run] || false
       @aggressive_cache_checking = config[:aggressive_cache_checking] || false
       @fake_responses = config[:fake_responses] || {}
-
       @logger = config[:logger]
       unless @logger
         @logger = Logger.new(STDERR)
@@ -69,9 +70,12 @@ module ApipieBindings
         :content_type => 'application/json',
         :accept       => "application/json;version=#{@api_version}"
       }
+      headers.merge!({ "Accept-Language" => language }) if language
       headers.merge!(config[:headers]) unless config[:headers].nil?
       headers.merge!(options.delete(:headers)) unless options[:headers].nil?
 
+      log.debug "Global headers: #{headers.ai}"
+
       resource_config = {
         :user     => config[:username],
         :password => config[:password],
@@ -84,17 +88,9 @@ module ApipieBindings
       @config = config
     end
 
-    def set_default_name(default='default')
-      cache_file = Dir["#{@apidoc_cache_dir}/*.json"].first
-      if cache_file
-        File.basename(cache_file, ".json")
-      else
-        default
-      end
-    end
 
     def apidoc_cache_file
-       File.join(@apidoc_cache_dir, "#{@apidoc_cache_name}.json")
+       File.join(@apidoc_cache_dir, "#{@apidoc_cache_name}#{cache_extension}")
     end
 
     def load_apidoc
@@ -166,6 +162,7 @@ module ApipieBindings
     # @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
+    #   * *:reduce_response_log* (Bool) - do not show response content in the log.
     # @example show user data
     #   http_call('get', '/api/users/1')
     def http_call(http_method, path, params={}, headers={}, options={})
@@ -185,6 +182,7 @@ module ApipieBindings
 
       log.info "#{http_method.to_s.upcase} #{path}"
       log.debug "Params: #{params.ai}"
+      log.debug "Headers: #{headers.ai}"
 
       args << headers if headers
 
@@ -193,24 +191,21 @@ module ApipieBindings
         ex = options[:fake_response ] || empty_response
         response = RestClient::Response.create(ex.response, ex.status, args)
       else
-        response = @client[path].send(*args)
-        update_cache(response.headers[:apipie_checksum])
+        begin
+          response = @client[path].send(*args)
+          update_cache(response.headers[:apipie_checksum])
+        rescue => e
+          log.error e.message + "\n" +
+            (e.respond_to?(:response) ? process_data(e.response).ai : e.ai)
+          raise
+        end
       end
 
       result = options[:response] == :raw ? response : process_data(response)
-      log.debug "Response #{result.ai}"
+      log.debug "Response %s" % (options[:reduce_response_log] ? "Received OK" : result.ai)
       result
     end
 
-    def process_data(response)
-      data = begin
-               JSON.parse(response.body)
-             rescue JSON::ParserError
-               response.body
-             end
-      # logger.debug "Returned data: #{data.inspect}"
-      return data
-    end
 
     def update_cache(cache_name)
       if !cache_name.nil? && (cache_name != @apidoc_cache_name)
@@ -222,7 +217,7 @@ module ApipieBindings
 
     def clean_cache
       @apidoc = nil
-      Dir["#{@apidoc_cache_dir}/*.json"].each { |f| File.delete(f) }
+      Dir["#{@apidoc_cache_dir}/*#{cache_extension}"].each { |f| File.delete(f) }
     end
 
     def check_cache
@@ -242,21 +237,37 @@ module ApipieBindings
 
     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)")
+      if language
+        response = retrieve_apidoc_call("/apidoc/v#{@api_version}.#{language}.json", :safe => true)
+        language_family = language.split('_').first
+        if !response && language_family != language
+          response = retrieve_apidoc_call("/apidoc/v#{@api_version}.#{language_family}.json", :safe => true)
+        end
+      end
+      unless response
+        begin
+          response = retrieve_apidoc_call("/apidoc/v#{@api_version}.json")
+        rescue
+          raise ApipieBindings::DocLoadingError.new(
+            "Could not load data from #{@uri}\n"\
+            " - is your server down?\n"\
+            " - was rake apipie:cache run when using apipie cache? (typical production settings)")
+        end
       end
       File.open(apidoc_cache_file, "w") { |f| f.write(response.body) }
       log.debug "New apidoc loaded from the server"
       load_apidoc
     end
 
+    def retrieve_apidoc_call(path, options={})
+      begin
+        http_call('get', path, {},
+          {:accept => "application/json"}, {:response => :raw, :reduce_response_log => true})
+      rescue
+        raise unless options[:safe]
+      end
+    end
+
     def find_match(fakes, resource, action, params)
       resource = fakes[[resource, action]]
       if resource
@@ -269,6 +280,28 @@ module ApipieBindings
       return nil
     end
 
+    def cache_extension
+      language ? ".#{language}.json" : ".json"
+    end
+
+    def set_default_name(default='default')
+      cache_file = Dir["#{@apidoc_cache_dir}/*#{cache_extension}"].first
+      if cache_file
+        File.basename(cache_file, cache_extension)
+      else
+        default
+      end
+    end
+
+    def process_data(response)
+      data = begin
+               JSON.parse(response.body)
+             rescue JSON::ParserError
+               response.body
+             end
+      # logger.debug "Returned data: #{data.inspect}"
+      return data
+    end
   end
 
 end

data/lib/apipie_bindings/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apipie-bindings
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Martin Bačovský
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-21 00:00:00.000000000 Z
+date: 2014-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -134,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: The Ruby bindings for Apipie documented APIs