apipie-bindings 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff423fb9cfff64a08d97f4a3709b25e03efa1289
-  data.tar.gz: 589750c97d73e14a76480b7f286652706fcb2871
+  metadata.gz: 7c09e522a914498b0cc1edbefcbcfc9a31bdde5e
+  data.tar.gz: 64e1e5df75c1c34e48bacfbee89b918a82d4d67b
 SHA512:
-  metadata.gz: d98b130b8d4bfc3d0f8b8b55da47491ab310d0a3bc5a9bfc6486863d02153bcff05656584225a164e7b746b4f32dcf998fb5f38faf6e1d0faae3884878abd7f9
-  data.tar.gz: eefe52e4281fde2e644eb2be132d2f4045d9803966f8ab4016a8f2fb1b9adb158d75ac0e29c9e35ea24e803870ee694f433c16570726aa4add3f23b2fd075522
+  metadata.gz: 87f289b0d316e15d468abdf01bad936c9692dd9834ac0fc8e847225f26c54400778b1c8134cf800b1dad6c4e2cb66861ca44e935d537c7d3b641e2074ac9a434
+  data.tar.gz: ceeeab2bf484187e116bdcf72c3f32a148e282ec3234ed59c38211b85d0a55631ebb73648067a5923c0e97db23abe86a2c8b5657aa27e9b735c3dbd7c2643a71

data/LICENSE

@@ -1,5 +1,20 @@
-This program and entire repository is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.
+Copyright 2014 Martin Bačovský and contributors
 
-This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
 
-You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -84,4 +84,4 @@ TODO
 License
 -------
 
-This project is licensed under the GPLv3+.
+This project is licensed under the MIT license.

data/doc/release_notes.md

@@ -1,6 +1,12 @@
 Release notes
 =============
 
+### 0.0.11 (2014-11-09)
+* Added lazy loading of credentials ([#7408](http://projects.theforeman.org/issues/7408))
+* Separate caches for different API versions ([#18](http://github.com/Apipie/apipie-bindings/issues/18))
+* Change license to MIT
+* List missing parameter names in validation exception message
+
 ### 0.0.10 (2014-09-18)
 * apipie-bindings should enforce required params, BZ 1116803 ([#6820](http://projects.theforeman.org/issues/6820))
 

data/lib/apipie_bindings.rb

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

data/lib/apipie_bindings/api.rb

@@ -21,6 +21,10 @@ module ApipieBindings
     #   * *:consumer_key* (String) OAuth key
     #   * *:consumer_secret* (String) OAuth secret
     #   * *:options* (Hash) options passed to OAuth
+    # @option config [AbstractCredentials] :credentials object implementing {AbstractCredentials}
+    #   interface e.g. {https://github.com/theforeman/hammer-cli-foreman/blob/master/lib/hammer_cli_foreman/credentials.rb HammerCLIForeman::BasicCredentials}
+    #   This is prefered way to pass credentials. Credentials acquired form :credentials object take
+    #   precedence over explicite params
     # @option config [Hash] :headers additional headers to send with the requests
     # @option config [String] :api_version ('1') version of the API
     # @option config [String] :language prefered locale for the API description
@@ -30,6 +34,9 @@ module ApipieBindings
     #   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.
+    # @option config [String] :apidoc_authenticated (true) whether or not does the call to
+    #   obtain API description use authentication. It is useful to avoid unnecessary prompts
+    #   for credentials
     # @option config [Hash] :fake_responses ({}) responses to return if used in dry run mode
     # @option config [Bool] :dry_run (false) dry run mode allows to test your scripts
     #   and not touch the API. The results are taken form exemples in the API description
@@ -56,8 +63,9 @@ module ApipieBindings
       @api_version = config[:api_version] || 1
       @language = config[:language]
       apidoc_cache_base_dir = config[:apidoc_cache_base_dir] || File.join(File.expand_path('~/.cache'), 'apipie_bindings')
-      @apidoc_cache_dir = config[:apidoc_cache_dir] || File.join(apidoc_cache_base_dir, @uri.tr(':/', '_'))
+      @apidoc_cache_dir = config[:apidoc_cache_dir] || File.join(apidoc_cache_base_dir, @uri.tr(':/', '_'), "v#{@api_version}")
       @apidoc_cache_name = config[:apidoc_cache_name] || set_default_name
+      @apidoc_authenticated = (config[:apidoc_authenticated].nil? ? true : config[:apidoc_authenticated])
       @dry_run = config[:dry_run] || false
       @aggressive_cache_checking = config[:aggressive_cache_checking] || false
       @fake_responses = config[:fake_responses] || {}
@@ -79,15 +87,13 @@ module ApipieBindings
 
       log.debug "Global headers: #{headers.ai}"
 
-      resource_config = {
-        :user     => config[:username],
-        :password => config[:password],
-        :oauth    => config[:oauth],
+      @credentials = config[:credentials] if config[:credentials] && config[:credentials].respond_to?(:to_params)
+
+      @resource_config = {
         :timeout  => config[:timeout],
         :headers  => headers
       }.merge(options)
 
-      @client = RestClient::Resource.new(config[:uri], resource_config)
       @config = config
     end
 
@@ -141,6 +147,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
+    #   * *:with_authentication* (Bool) *true* - use rest client with/without auth configuration
     # @example show user data
     #   call(:users, :show, :id => 1)
     def call(resource_name, action_name, params={}, headers={}, options={})
@@ -166,6 +173,7 @@ module ApipieBindings
     # @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.
+    #   * *:with_authentication* (Bool) *true* - use rest client with/without auth configuration
     # @example show user data
     #   http_call('get', '/api/users/1')
     def http_call(http_method, path, params={}, headers={}, options={})
@@ -196,7 +204,10 @@ module ApipieBindings
         response = RestClient::Response.create(ex.response, net_http_resp, args)
       else
         begin
-          response = @client[path].send(*args)
+          apidoc_without_auth = (path =~ /\/apidoc\//) && !@apidoc_authenticated
+          authenticate = options[:with_authentication].nil? ? !apidoc_without_auth : options[:with_authentication]
+          client = authenticate ? authenticated_client : unauthenticated_client
+          response = call_client(client, path, args)
           update_cache(response.headers[:apipie_checksum])
         rescue => e
           log.debug e.message + "\n" +
@@ -227,19 +238,13 @@ module ApipieBindings
 
     def check_cache
       begin
-        response = http_call('get', "/apidoc/apipie_checksum", {}, {:accept => "application/json"})
+        response = http_call('get', "/apidoc/apipie_checksum", {}, { :accept => "application/json" })
         response['checksum']
       rescue
         nil
       end
     end
 
-    def log
-      @logger
-    end
-
-    private
-
     def retrieve_apidoc
       FileUtils.mkdir_p(@apidoc_cache_dir) unless File.exists?(@apidoc_cache_dir)
       if language
@@ -264,6 +269,33 @@ module ApipieBindings
       load_apidoc
     end
 
+    def log
+      @logger
+    end
+
+    private
+
+    def call_client(client, path, args)
+      client[path].send(*args)
+    end
+
+    def authenticated_client
+      unless @client_with_auth
+        resource_config = @resource_config.merge({
+          :user     => @config[:username],
+          :password => @config[:password],
+          :oauth    => @config[:oauth],
+        })
+        resource_config.merge!(@credentials.to_params) if @credentials
+        @client_with_auth = RestClient::Resource.new(@config[:uri], resource_config)
+      end
+      @client_with_auth
+    end
+
+    def unauthenticated_client
+      @client_without_auth ||= RestClient::Resource.new(@config[:uri], @resource_config)
+    end
+
     def retrieve_apidoc_call(path, options={})
       begin
         http_call('get', path, {},

data/lib/apipie_bindings/credentials.rb

@@ -0,0 +1,22 @@
+module ApipieBindings
+
+  # AbstractCredentials class can hold your logic to get
+  # users credentials. It defines interface that can be used
+  # by ApipieBindings when the credentials are needed to create connection
+  class AbstractCredentials
+
+    # Convert credentials to hash usable for merging to RestClient configuration
+    # @return [Hash]
+    def to_params
+      {}
+    end
+
+    # Check that credentials storage is empty
+    def empty?
+    end
+
+    # Clear credentials storage
+    def clear
+    end
+  end
+end

data/lib/apipie_bindings/exceptions.rb

@@ -10,6 +10,10 @@ module ApipieBindings
       @params = params
     end
 
+    def to_s
+      "#{super}: #{params.join(',')}"
+    end
+
   end
 
 end

data/lib/apipie_bindings/version.rb

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

data/test/unit/action_test.rb

@@ -42,14 +42,16 @@ describe ApipieBindings::Action do
 
 
   it "should validate incorrect params" do
-    proc do
+    e = proc do
       resource.action(:create).validate!({ :architecture => { :foo => "foo" } })
     end.must_raise(ApipieBindings::MissingArgumentsError)
+    e.message.must_match /: name$/
 
-    proc do
+    e = proc do
       # completely different sub-hash; should still fail
       resource.action(:create).validate!({ :organization => { :name => "acme" } })
     end.must_raise(ApipieBindings::MissingArgumentsError)
+    e.message.must_match /: name$/
   end
 
   it "should accept correct params" do

data/test/unit/api_test.rb

@@ -17,9 +17,6 @@ describe ApipieBindings::API do
     api.resources.map(&:name).must_equal [:architectures]
   end
 
-  # it "should have apidoc_cache_file available" do
-  # end
-
   it "should call the method" do
     params = { :a => 1 }
     headers = { :content_type => 'application/json' }
@@ -143,8 +140,54 @@ describe ApipieBindings::API do
 
     it "should obey :apidoc_cache_base_dir to generate apidoc_cache_dir" do
       Dir.mktmpdir do |dir|
-        api = ApipieBindings::API.new({:uri => 'http://example.com', :apidoc_cache_base_dir => dir})
-        api.apidoc_cache_file.must_equal File.join(dir, 'http___example.com', 'default.json')
+        api = ApipieBindings::API.new({:uri => 'http://example.com', :apidoc_cache_base_dir => dir, :api_version => 2})
+        api.apidoc_cache_file.must_equal File.join(dir, 'http___example.com', 'v2', 'default.json')
+      end
+    end
+  end
+
+  context "credentials" do
+
+    let(:fake_empty_response) {
+      data = ApipieBindings::Example.new('', '', '', 200, '[]')
+      net_http_resp = Net::HTTPResponse.new(1.0, data.status, "")
+      RestClient::Response.create(data.response, net_http_resp, {})
+    }
+
+    it "should call credentials to_param when :credentials are set and doing authenticated call" do
+      Dir.mktmpdir do |dir|
+        credentials = ApipieBindings::AbstractCredentials.new
+        api = ApipieBindings::API.new({
+          :uri => 'http://example.com', :apidoc_cache_base_dir => dir, :api_version => 2,
+          :credentials => credentials})
+        credentials.expects(:to_params).returns({:password => 'xxx'})
+        api.stubs(:call_client).returns(fake_empty_response)
+
+        api.http_call(:get, '/path')
+      end
+    end
+
+    it "should not require credentials for loading apidoc when :apidoc_authenticated => false" do
+      Dir.mktmpdir do |dir|
+        api = ApipieBindings::API.new({
+          :uri => 'http://example.com', :apidoc_cache_base_dir => dir, :api_version => 2,
+          :apidoc_authenticated => false })
+        api.expects(:unauthenticated_client)
+        api.stubs(:call_client).returns(fake_empty_response)
+
+        api.retrieve_apidoc
+      end
+    end
+
+    it "should not require credentials for loading checksum when :apidoc_authenticated => false" do
+      Dir.mktmpdir do |dir|
+        api = ApipieBindings::API.new({
+          :uri => 'http://example.com', :apidoc_cache_base_dir => dir, :api_version => 2,
+          :apidoc_authenticated => false })
+        api.expects(:unauthenticated_client)
+        api.stubs(:call_client).returns(fake_empty_response)
+
+        api.check_cache
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apipie-bindings
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Martin Bačovský
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-18 00:00:00.000000000 Z
+date: 2014-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -206,6 +206,7 @@ files:
 - lib/apipie_bindings.rb
 - lib/apipie_bindings/action.rb
 - lib/apipie_bindings/api.rb
+- lib/apipie_bindings/credentials.rb
 - lib/apipie_bindings/example.rb
 - lib/apipie_bindings/exceptions.rb
 - lib/apipie_bindings/indifferent_hash.rb
@@ -229,7 +230,7 @@ files:
 - test/unit/test_helper.rb
 homepage: http://github.com/Apipie/apipie-bindings
 licenses:
-- GPL-3
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -263,4 +264,3 @@ test_files:
 - test/unit/resource_test.rb
 - test/unit/route_test.rb
 - test/unit/test_helper.rb
-has_rdoc: yard