heroics 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71ffe47375db83f6d799ab0fba948893c9e242b2
-  data.tar.gz: b38fd2974615c491bebab27ef593a91769247af6
+  metadata.gz: db15e29f26b3dba405af8b01a48edcad2d2d7acd
+  data.tar.gz: 3854c7caff8cd64471b6b57b58c2ab807d971a48
 SHA512:
-  metadata.gz: 5aae57f3c48275ac9d1c70008cdd64322e39ee44ce44adc3b0e88cf824fbf4904ab41547b0d423e7c42458b27cccbe521050532eec011ad677d0ea3a705d9ae1
-  data.tar.gz: e0fc57b7e0e20fca7fd5ca5a1d069597c4f311183bfe440b7be33645342f0781e574808b4cca29cfb093f9a92b3393e8a89b49b247c8ecf0750ff6e16be1cbff
+  metadata.gz: a01a0b5e5f9662efd580ab1f4c869907c017baa43ca5faa0c0179c6593547d58a01fd33b4d285215420ebc01c0819f2ade58153368e0bfb304c9f268de6146f0
+  data.tar.gz: e47f14886442b6739220abb5fccd561db5e73885daab3b595c034ef6540a21e9265bf6837690f49cb6b964b953c27422c2794e8c84dc4ec1471c1cade5006208

data/lib/heroics/client.rb

@@ -18,10 +18,15 @@ module Heroics
     # @raise [NoMethodError] Raised if the name doesn't match a known resource.
     # @return [Resource] The resource matching the name.
     def method_missing(name)
-      name = name.to_s.gsub('_', '-')
+      name = name.to_s
       resource = @resources[name]
       if resource.nil?
-        raise NoMethodError.new("undefined method `#{name}' for #{to_s}")
+        # Try substituting underscores for dashes
+        name = name.to_s.gsub('_', '-')
+        resource = @resources[name]
+        if resource.nil?
+          raise NoMethodError.new("undefined method `#{name}' for #{to_s}")
+        end
       end
       resource
     end

data/lib/heroics/client_generator.rb

@@ -80,8 +80,12 @@ module Heroics
       end
     end
 
-    # The list of parameters to render in generated source code for the method
-    # signature for the link.
+    # list of parameters for method signature, body is optional
+    def method_signature
+      @parameters.map { |info| info.name == 'body' ? "body = {}" : info.name }.join(', ')
+    end
+
+    # list of parameters to pass along from method signature to client calls
     def parameter_names
       @parameters.map { |info| info.name }.join(', ')
     end

data/lib/heroics/link.rb

@@ -48,14 +48,24 @@ module Heroics
       path = "#{@path_prefix}#{path}" unless @path_prefix == '/'
       headers = @default_headers
       if body
-        headers = headers.merge({'Content-Type' => @link_schema.content_type})
-        body = @link_schema.encode(body)
+        case @link_schema.method
+        when :put, :post, :patch
+          headers = headers.merge({'Content-Type' => @link_schema.content_type})
+          body = @link_schema.encode(body)
+        when :get, :delete
+          if body.is_a?(Hash)
+            query = body
+          else
+            query = MultiJson.load(body)
+          end
+          body = nil
+        end
       end
 
       connection = Excon.new(@root_url, thread_safe_sockets: true)
       response = request_with_cache(connection,
                                     method: @link_schema.method, path: path,
-                                    headers: headers, body: body,
+                                    headers: headers, body: body, query: query,
                                     expects: [200, 201, 202, 204, 206])
       content_type = response.headers['Content-Type']
       if content_type && content_type =~ /application\/.*json/

data/lib/heroics/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Heroics
-  VERSION = '0.0.16'
+  VERSION = '0.0.17'
 end

data/lib/heroics/views/client.erb

@@ -11,19 +11,27 @@ require 'heroics'
 require 'uri'
 
 module <%= @module_name %>
-  # Get a Client configured to use HTTP Basic authentication.
+  # Get a Client configured to use HTTP Basic or header-based authentication.
   #
   # @param api_key [String] The API key to use when connecting.
   # @param options [Hash<Symbol,String>] Optionally, custom settings
   #   to use with the client.  Allowed options are `default_headers`,
   #   `cache`, `user` and `url`.
   # @return [Client] A client configured to use the API with HTTP Basic
-  #   authentication.
+  #   or header-based authentication.
   def self.connect(api_key, options=nil)
     options = custom_options(options)
     uri = URI.parse(options[:url])
-    uri.user = URI.encode_www_form_component options.fetch(:user, 'user')
-    uri.password = api_key
+
+    if options[:user]
+      uri.user = URI.encode_www_form_component options[:user]
+    end
+
+    if api_key
+      uri.user ||= 'user'
+      uri.password = api_key
+    end
+
     client = Heroics.client_from_schema(SCHEMA, uri.to_s, options)
     Client.new(client)
   end
@@ -116,7 +124,7 @@ module <%= @module_name %>
     # @param <%= parameter.name %>: <%= parameter.description %>
     <% end %>
     <% end %>
-    def <%= link.name %>(<%= link.parameter_names %>)
+    def <%= link.name %>(<%= link.method_signature %>)
       @client.<%= resource.name %>.<%= link.name %>(<%= link.parameter_names %>)
     end
     <% end %>

data/test/client_test.rb

@@ -45,6 +45,23 @@ class ClientTest < MiniTest::Unit::TestCase
     assert_equal('Hello, world!', client.resource.link)
   end
 
+  # Client.<resource>.<link> finds the appropriate link and invokes it with
+  #   query params, since it is a GET resource
+  def test_resource_with_query_param
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = Heroics::Link.new('https://username:secret@example.com',
+                             schema.resource('resource').link('list'))
+    resource = Heroics::Resource.new({'link' => link})
+    client = Heroics::Client.new({'resource' => resource},
+                                 'http://example.com')
+    Excon.stub(method: :get) do |request|
+      assert_equal({:limit => '50', :page => '25'}, request[:query])
+      Excon.stubs.pop
+      {status: 200, body: 'Hello, world!'}
+    end
+    assert_equal('Hello, world!', client.resource.link(limit: '50', page: '25'))
+  end
+
   # Client converts underscores in resource method names to dashes to match
   # names specified in the schema.
   def test_resource_with_dashed_name
@@ -65,6 +82,27 @@ class ClientTest < MiniTest::Unit::TestCase
     end
     assert_equal('Hello, world!', client.another_resource.link)
   end
+
+  # Client.<resource>.<link> finds the appropriate link and invokes it, even if
+  # the resource has an underscore in its name
+  def test_resource_with_underscored_name
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = Heroics::Link.new('https://username:secret@example.com',
+                             schema.resource('underscored_resource').link('list'))
+    resource = Heroics::Resource.new({'link' => link})
+    client = Heroics::Client.new({'underscored_resource' => resource},
+                                 'http://example.com')
+    Excon.stub(method: :get) do |request|
+      assert_equal('Basic dXNlcm5hbWU6c2VjcmV0',
+                   request[:headers]['Authorization'])
+      assert_equal('example.com', request[:host])
+      assert_equal(443, request[:port])
+      assert_equal('/underscored_resource', request[:path])
+      Excon.stubs.pop
+      {status: 200, body: 'Hello, world!'}
+    end
+    assert_equal('Hello, world!', client.underscored_resource.link)
+  end
 end
 
 class ClientFromSchemaTest < MiniTest::Unit::TestCase

data/test/helper.rb

@@ -192,9 +192,30 @@ SAMPLE_SCHEMA = {
          'title'       => 'List'}
       ]
     },
+
+    'underscored_resource' => {
+      'description' => 'Underscores the importance of supporting underscored resources',
+      'id'          => 'schema/underscored_resource',
+      '$schema'     => 'http://json-schema.org/draft-04/hyper-schema',
+      'title'       => 'Another underscored resource to use in tests',
+      'type'        => ['object'],
+
+      'definitions' => {},
+
+      'properties' => {},
+
+      'links' => [
+        {'description' => 'Show all underscored resources',
+         'href'        => '/underscored_resource',
+         'method'      => 'GET',
+         'rel'         => 'instances',
+         'title'       => 'List'}
+      ]
+    },
   },
   'properties' => {
     'resource'          => { '$ref' => '#/definitions/resource' },
-    'another-resource'  => { '$ref' => '#/definitions/another-resource' }
+    'another-resource'  => { '$ref' => '#/definitions/another-resource' },
+    'underscored_resource'  => { '$ref' => '#/definitions/underscored_resource' }
   }
 }

data/test/schema_test.rb

@@ -29,7 +29,7 @@ class SchemaTest < MiniTest::Unit::TestCase
   # Schema.resources returns a sequence of ResourceSchema children.
   def test_resources
     schema = Heroics::Schema.new(SAMPLE_SCHEMA)
-    assert_equal(['resource', 'another-resource'],
+    assert_equal(['resource', 'another-resource', 'underscored_resource'],
                  schema.resources.map(&:name))
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heroics
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - geemus
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-08 00:00:00.000000000 Z
+date: 2016-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler