heroics 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecdb1c591d9352b73ba1b720cead8bcd9c690b49
-  data.tar.gz: be82ea121fecbcf6bf9761521518a999d888fe33
+  metadata.gz: e1f56fc7f7100a44079eaaec68a2e7194992fc9c
+  data.tar.gz: 0c3730316fa3f9329b3406cc4fa25ce44331d409
 SHA512:
-  metadata.gz: 3ac51fd3d654d02de41058362d324cac0835974d3b602c1845ab56b1563a40f6c1a995409e74ae1b9ec6b4496eef02feabe82f8068cb7eb3c1b4f8094e9d942c
-  data.tar.gz: 8ef27a5f558e7e09c1cad67f46971db41b8cbf0ba0c777305d6c05e86761522514345cc4a2ecbce0755bbb6cec1ba1644bebabf9ec897ae2014cc9db2bf29458
+  metadata.gz: 461418c693655d9d717f7a9cdf00dc678f6c569655a3eb954678be101c5da93ba1f242cfa25e3a1c3c4683b3dd0e9a0b29467a9813428f5089c39792496adba9
+  data.tar.gz: 83c9808500e1927af547fa5fa2bb679667c9812133a6065dcf6714d6b32f8539e76477d2ccfaf02e26f28e7388c83c8de2b9aefba7c91354c357834798a71cd6

data/.travis.yml

@@ -1,3 +1,6 @@
 language: ruby
 rvm:
   - 1.9.3
+  - 2.0.0-p598
+  - 2.1.5
+  - 2.2.0

data/bin/heroics-generate

@@ -2,10 +2,11 @@
 
 require 'optparse'
 require 'heroics'
+require 'open-uri'
 
 options = {headers: {}, cache_path: nil}
 option_parser = OptionParser.new do |opts|
-  opts.banner = 'Usage: heroics-generate module_name schema_filename url'
+  opts.banner = 'Usage: heroics-generate module_name schema_filepath url'
 
   opts.on('-h', '--help', 'Display this screen') do
     puts opts
@@ -28,8 +29,8 @@ option_parser.parse!
 if ARGV.length != 3
   puts option_parser
 else
-  module_name, schema_filename, url = ARGV
-  schema = Heroics::Schema.new(MultiJson.decode(File.read(schema_filename)))
+  module_name, schema_filepath, url = ARGV
+  schema = Heroics::Schema.new(MultiJson.decode(open(schema_filepath).read))
   cache = 'Moneta.new(:Memory)'
   if options[:cache_path]
     cache = "Moneta.new(:File, dir: \"#{options[:cache_path]}\")"

data/lib/heroics/link.rb

@@ -47,8 +47,8 @@ module Heroics
       path = "#{@path_prefix}#{path}" unless @path_prefix == '/'
       headers = @default_headers
       if body
-        headers = headers.merge({'Content-Type' => 'application/json'})
-        body = MultiJson.dump(body)
+        headers = headers.merge({'Content-Type' => @link_schema.content_type})
+        body = @link_schema.encode(body)
       end
       cache_key = "#{path}:#{headers.hash}"
       if @link_schema.method == :get
@@ -59,11 +59,11 @@ module Heroics
       connection = Excon.new(@root_url)
       response = connection.request(method: @link_schema.method, path: path,
                                     headers: headers, body: body,
-                                    expects: [200, 201, 202, 206, 304])
+                                    expects: [200, 201, 202, 204, 206, 304])
       content_type = response.headers['Content-Type']
       if response.status == 304
         MultiJson.load(@cache["data:#{cache_key}"])
-      elsif content_type && content_type.include?('application/json')
+      elsif content_type && content_type =~ /application\/.*json/
         etag = response.headers['ETag']
         if etag
           @cache["etag:#{cache_key}"] = etag

data/lib/heroics/schema.rb

@@ -24,7 +24,6 @@ module Heroics
     # @param name [String] The name of the resource.
     # @raise [SchemaError] Raised if an unknown resource name is provided.
     def resource(name)
-      resource_schema = @resources[name]
       if @schema['definitions'].has_key?(name)
         ResourceSchema.new(@schema, name)
       else
@@ -58,7 +57,8 @@ module Heroics
     def initialize(schema, name)
       @schema = schema
       @name = name
-      link_schema = schema['definitions'][name]['links']
+      link_schema = schema['definitions'][name]['links'] || []
+
       @links = Hash[link_schema.each_with_index.map do |link, link_index|
                       link_name = Heroics.ruby_name(link['title'])
                       [link_name, LinkSchema.new(schema, name, link_index)]
@@ -128,6 +128,22 @@ module Heroics
       link_schema['method'].downcase.to_sym
     end
 
+    # Get the Content-Type for this link.
+    #
+    # @return [String] The Content-Type value
+    def content_type
+      link_schema['encType'] || 'application/json'
+    end
+
+    def encode(body)
+      case content_type
+      when 'application/x-www-form-urlencoded'
+        URI.encode_www_form(body)
+      when /application\/.*json/
+        MultiJson.dump(body)
+      end
+    end
+
     # Get the names of the parameters this link expects.
     #
     # @return [Array<String>] The parameters.
@@ -307,7 +323,8 @@ module Heroics
     # @param [Fixnum,String,TrueClass,FalseClass,Time] The parameter to format.
     # @return [String] The formatted parameter.
     def format_parameter(parameter)
-      parameter.instance_of?(Time) ? iso_format(parameter) : parameter.to_s
+      formatted_parameter = parameter.instance_of?(Time) ? iso_format(parameter) : parameter.to_s
+      URI.escape formatted_parameter
     end
 
     # Convert a time to an ISO 8601 combined data and time format.

data/lib/heroics/version.rb

@@ -1,3 +1,3 @@
 module Heroics
-  VERSION = '0.0.12'
+  VERSION = '0.0.13'
 end

data/test/helper.rb

@@ -127,6 +127,25 @@ SAMPLE_SCHEMA = {
              'email_field' => {
                '$ref' => '#/definitions/resource/definitions/email_field'}}}},
 
+        {'description' => 'Submit a sample resource as form data',
+         'encType'     => 'application/x-www-form-urlencoded',
+         'href'        => '/resource',
+         'method'      => 'POST',
+         'rel'         => 'submit',
+         'title'       => 'Submit',
+         'schema'      => {
+           'properties' => {
+             'date_field' => {
+               '$ref' => '#/definitions/resource/definitions/date_field'},
+             'string_field' => {
+               '$ref' => '#/definitions/resource/definitions/string_field'},
+             'boolean_field' => {
+               '$ref' => '#/definitions/resource/definitions/boolean_field'},
+             'uuid_field' => {
+               '$ref' => '#/definitions/resource/definitions/uuid_field'},
+             'email_field' => {
+               '$ref' => '#/definitions/resource/definitions/email_field'}}}},
+
         {'description' => 'Update a sample resource',
          'href'        => '/resource/{(%23%2Fdefinitions%2Fresource%2Fdefinitions%2Fuuid_field)}',
          'method'      => 'PATCH',

data/test/link_test.rb

@@ -38,6 +38,20 @@ class LinkTest < MiniTest::Unit::TestCase
     assert_equal(nil, link.run('44724831-bf66-4bc2-865f-e2c4c2b14c78'))
   end
 
+  # Link.run URL-escapes special characters in parameters.
+  def test_run_with_parameters_needing_escaping
+    Excon.stub(method: :get) do |request|
+      assert_equal('/resource/foo%23bar', request[:path])
+      Excon.stubs.pop
+      {status: 200, body: ''}
+    end
+
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = Heroics::Link.new('https://example.com',
+                             schema.resource('resource').link('info'))
+    assert_equal(nil, link.run('foo#bar'))
+  end
+
   # Link.run converts Time parameters to UTC before sending them to the
   # server.
   def test_run_converts_time_parameters_to_utc
@@ -71,6 +85,25 @@ class LinkTest < MiniTest::Unit::TestCase
     assert_equal(nil, link.run(body))
   end
 
+  # Link.run optionally takes an extra parameter to send in the request body.
+  # It automatically converts the specified object to the specified encoding
+  # type and includes a Content-Type header in the request
+  def test_run_without_parameters_and_with_non_json_request_body
+    body = {'Hello' => 'world!'}
+    Excon.stub(method: :post) do |request|
+      assert_equal('application/x-www-form-urlencoded', request[:headers]['Content-Type'])
+      assert_equal('Hello=world%21', request[:body])
+      Excon.stubs.pop
+      {status: 200, body: ''}
+    end
+
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = Heroics::Link.new('https://example.com',
+                             schema.resource('resource').link('submit'))
+    assert_equal(nil, link.run(body))
+  end
+
+
   # Link.run passes custom headers to the server when they've been provided.
   def test_run_with_custom_request_headers
     Excon.stub(method: :get) do |request|
@@ -178,7 +211,7 @@ class LinkTest < MiniTest::Unit::TestCase
       assert_equal('/resource', request[:path])
       Excon.stubs.pop
       {status: 200,
-       headers: {'Content-Type' => 'application/json;charset=utf-8'},
+       headers: {'Content-Type' => 'application/vnd.api+json;charset=utf-8'},
        body: MultiJson.dump(body)}
     end
 
@@ -204,6 +237,20 @@ class LinkTest < MiniTest::Unit::TestCase
     assert_equal(body, link.run)
   end
 
+  # Link.run considers HTTP 204 No Content responses as successful.
+  def test_run_with_no_content_response
+    Excon.stub(method: :delete) do |request|
+      assert_equal("/resource/2013-01-01T08:00:00Z", request[:path])
+      Excon.stubs.pop
+      {status: 204, body: ''}
+    end
+
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = Heroics::Link.new('https://example.com',
+                             schema.resource('resource').link('delete'))
+    assert_equal(nil, link.run(Time.parse('2013-01-01 00:00:00-0800')))
+  end
+
   # Link.run raises an Excon error if anything other than a 200 or 201 HTTP
   # status code was returned by the server.
   def test_run_with_failed_request
@@ -251,8 +298,9 @@ class LinkTest < MiniTest::Unit::TestCase
       {status: 200}
     end
 
+    headers = {}
     cache = Moneta.new(:Memory)
-    cache['etag:/resource:0'] = 'etag-contents'
+    cache["etag:/resource:#{headers.hash}"] = 'etag-contents'
     schema = Heroics::Schema.new(SAMPLE_SCHEMA)
     link = Heroics::Link.new('https://example.com',
                              schema.resource('resource').link('list'),
@@ -287,9 +335,10 @@ class LinkTest < MiniTest::Unit::TestCase
       {status: 304, headers: {'Content-Type' => 'application/json'}}
     end
 
+    headers = {}
     cache = Moneta.new(:Memory)
-    cache['etag:/resource:0'] = 'etag-contents'
-    cache['data:/resource:0'] = MultiJson.dump(body)
+    cache["etag:/resource:#{headers.hash}"] = 'etag-contents'
+    cache["data:/resource:#{headers.hash}"] = MultiJson.dump(body)
     schema = Heroics::Schema.new(SAMPLE_SCHEMA)
     link = Heroics::Link.new('https://example.com',
                              schema.resource('resource').link('list'),

data/test/schema_test.rb

@@ -54,7 +54,7 @@ class ResourceSchemaTest < MiniTest::Unit::TestCase
   def test_links
     schema = Heroics::Schema.new(SAMPLE_SCHEMA)
     assert_equal(
-      ['list', 'info', 'identify_resource', 'create', 'update', 'delete'],
+      ['list', 'info', 'identify_resource', 'create', 'submit', 'update', 'delete'],
       schema.resource('resource').links.map { |link| link.name })
   end
 end
@@ -167,6 +167,14 @@ class LinkSchemaTest < MiniTest::Unit::TestCase
                  link.format_path(['44724831-bf66-4bc2-865f-e2c4c2b14c78']))
   end
 
+  # LinkSchema.format_path escapes special URL characters in parameters.
+  def test_format_path_with_illegal_literals
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('resource').link('info')
+    assert_equal(['/resource/foobar%25', nil],
+                 link.format_path(['foobar%']))
+  end
+
   # LinkSchema.format_path correctly returns a parameter as a body if a path
   # doesn't have any parameters.
   def test_format_path_with_body
@@ -224,6 +232,21 @@ class LinkSchemaTest < MiniTest::Unit::TestCase
     link = schema.resource('resource').link('identify_resource')
     assert_equal('identify-resource', link.pretty_name)
   end
+
+  # LinkSchema.content_type returns the media type associated with this
+  # resource.
+  def test_content_type
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('resource').link('submit')
+    assert_equal('application/x-www-form-urlencoded', link.content_type)
+  end
+
+  # The content type should default to application/json
+  def test_default_content_type
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = schema.resource('resource').link('identify_resource')
+    assert_equal('application/json', link.content_type)
+  end
 end
 
 class DownloadSchemaTest < MiniTest::Unit::TestCase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heroics
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - geemus
@@ -9,20 +9,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-22 00:00:00.000000000 Z
+date: 2015-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
@@ -43,98 +43,98 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: turn
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.7.0
 - !ruby/object:Gem::Dependency
   name: excon
   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: moneta
   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: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.9.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.9.2
 - !ruby/object:Gem::Dependency
   name: netrc
   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'
 description: A Ruby client generator for HTTP APIs described with a JSON schema
@@ -147,8 +147,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CONTRIBUTING.md
 - CONTRIBUTORS.md
 - Gemfile
@@ -192,17 +192,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A Ruby client generator for HTTP APIs described with a JSON schema