heroics 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa499bd9600ebaf398364bede676a650e59b9069
-  data.tar.gz: 1d3cc821c826a4de74c668357bb992e0cb65312f
+  metadata.gz: 5fdba196ca9514256d462ec682debf617bf37f16
+  data.tar.gz: af76b3f90fd215ee446b0c954b35dbf9071c3b2e
 SHA512:
-  metadata.gz: 4e355d82e3f72aa0f753beda66de2571a0428436a7edc3ebe7553657572361bf6e1e6b49956a97c953ef86d163f1ebcc231cf5db2935bfe5212200c09e6a5d68
-  data.tar.gz: 1fd82c26f754a3a4934a907cfeb03816ef6919a387bdd7df5711ef12031c8dafff03b5ba0faecb9956fd3f1dfb896f04872ed893844faa2df9bb2fdb751ff52a
+  metadata.gz: a73cb1eba0b3ae7f3390612af5b99fdbd323a73838f810c569179bd0d6f25a15f85b500d1d934e37f627de84e802fc5b9c1d6674b3b0c3e81f6bf3bd66fd50e6
+  data.tar.gz: 313d065db244cb6c99c5ccb02ec781188125f5de45c35c77630966d046c3b6443a6e3217c20637fbbebb7b4dd5a6eb5c0279b0c14e9d4987790dc3db2dc013ee

data/.travis.yml

@@ -1,6 +1,8 @@
+sudo: false
 language: ruby
 rvm:
   - 1.9.3
-  - 2.0.0-p598
-  - 2.1.5
-  - 2.2.0
+  - 2.0.0-p648
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0

data/heroics.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'turn'
 
-  spec.add_dependency 'erubis', '~> 2.7.0'
+  spec.add_dependency 'erubis', '~> 2.0'
   spec.add_dependency 'excon'
   spec.add_dependency 'moneta'
   spec.add_dependency 'multi_json', '>= 1.9.2'

data/lib/heroics.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'base64'
 require 'erubis'
 require 'excon'

data/lib/heroics/cli.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Heroics
   class CLI
     # Instantiate a CLI for an API described by a JSON schema.

data/lib/heroics/client.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Heroics
   # An HTTP client with methods mapped to API resources.
   class Client

data/lib/heroics/client_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Heroics
   # Generate a static client that uses Heroics under the hood.  This is a good
   # option if you want to ship a gem or generate API documentation using Yard.

data/lib/heroics/command.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Heroics
   class Command
     # Instantiate a command.

data/lib/heroics/errors.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Heroics
   # Raised when a schema has an error that prevents it from being parsed
   # correctly.

data/lib/heroics/link.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Heroics
   # A link invokes requests with an HTTP server.
   class Link
@@ -50,25 +51,14 @@ module Heroics
         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
-        etag = @cache["etag:#{cache_key}"]
-        headers = headers.merge({'If-None-Match' => etag}) if etag
-      end
 
-      connection = Excon.new(@root_url)
-      response = connection.request(method: @link_schema.method, path: path,
+      connection = Excon.new(@root_url, thread_safe_sockets: true)
+      response = request_with_cache(connection,
+                                    method: @link_schema.method, path: path,
                                     headers: headers, body: body,
-                                    expects: [200, 201, 202, 204, 206, 304])
+                                    expects: [200, 201, 202, 204, 206])
       content_type = response.headers['Content-Type']
-      if response.status == 304
-        MultiJson.load(@cache["data:#{cache_key}"])
-      elsif content_type && content_type =~ /application\/.*json/
-        etag = response.headers['ETag']
-        if etag
-          @cache["etag:#{cache_key}"] = etag
-          @cache["data:#{cache_key}"] = response.body
-        end
+      if content_type && content_type =~ /application\/.*json/
         body = MultiJson.load(response.body)
         if response.status == 206
           next_range = response.headers['Next-Range']
@@ -83,7 +73,8 @@ module Heroics
               # next range.
               break unless next_range
               headers = headers.merge({'Range' => next_range})
-              response = connection.request(method: @link_schema.method,
+              response = request_with_cache(connection,
+                                            method: @link_schema.method,
                                             path: path, headers: headers,
                                             expects: [200, 201, 206])
               body = MultiJson.load(response.body)
@@ -100,6 +91,31 @@ module Heroics
 
     private
 
+    def request_with_cache(connection, options)
+      options[:expects] << 304
+      cache_key = "#{options[:path]}:#{options[:headers].hash}"
+      if options[:method] == :get
+        etag = @cache["etag:#{cache_key}"]
+        options[:headers] = options[:headers].merge({'If-None-Match' => etag}) if etag
+      end
+      response = connection.request(options)
+
+      if response.status == 304
+        body = @cache["data:#{cache_key}"]
+        status = @cache["status:#{cache_key}"]
+        headers = @cache["headers:#{cache_key}"]
+        CachedResponse.new(status, body, headers)
+      else
+        if etag = response.headers['ETag']
+          @cache["etag:#{cache_key}"] = etag
+          @cache["data:#{cache_key}"] = response.body
+          @cache["status:#{cache_key}"] = response.status
+          @cache["headers:#{cache_key}"] = response.headers
+        end
+        response
+      end
+    end
+
     # Unpack the URL and split it into a root URL and a path prefix, if one
     # exists.
     #
@@ -116,5 +132,15 @@ module Heroics
       path_prefix = parts[5]
       return root_url.join(''), path_prefix
     end
+
+    class CachedResponse
+      attr_reader :status, :body, :headers
+      def initialize(status, body, headers)
+        @status = status
+        @body = body
+        @headers = headers
+      end
+    end
+
   end
 end

data/lib/heroics/naming.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Heroics
   # Process a name to make it suitable for use as a Ruby method name.
   #

data/lib/heroics/resource.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Heroics
   # A resource with methods mapped to API links.
   class Resource

data/lib/heroics/schema.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Heroics
   # A wrapper around a bare JSON schema to make it easier to use.
   class Schema

data/lib/heroics/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Heroics
-  VERSION = '0.0.14'
+  VERSION = '0.0.15'
 end

data/lib/heroics/views/client.erb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 #
 # WARNING: Do not edit by hand, this file was generated by Heroics:
@@ -66,7 +67,7 @@ module <%= @module_name %>
       final_options[:default_headers].merge!(options[:default_headers])
     end
     final_options[:cache] = options[:cache] if options[:cache]
-    final_options[:url] = options[:url] if options[:url]
+    final_options[:url] = options[:url] || <%= @cache %>
     final_options[:user] = options[:user] if options[:user]
     final_options
   end
@@ -74,10 +75,8 @@ module <%= @module_name %>
   # Get the default options.
   def self.default_options
     default_headers = <%= @default_headers %>
-    cache = <%= @cache %>
     {
       default_headers: default_headers,
-      cache:           cache,
       url:             "<%= @url %>"
     }
   end

data/test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'netrc'
 
 _, token = Netrc.read['api.heroku.com']

data/test/cli_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'helper'
 require 'stringio'
 

data/test/client_generator_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'helper'
 require 'netrc'
 require 'stringio'

data/test/client_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'helper'
 
 class ClientTest < MiniTest::Unit::TestCase

data/test/command_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'helper'
 require 'stringio'
 

data/test/helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'minitest/autorun'
 require 'time'
 

data/test/link_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'helper'
 
 class LinkTest < MiniTest::Unit::TestCase
@@ -339,6 +340,8 @@ class LinkTest < MiniTest::Unit::TestCase
     cache = Moneta.new(:Memory)
     cache["etag:/resource:#{headers.hash}"] = 'etag-contents'
     cache["data:/resource:#{headers.hash}"] = MultiJson.dump(body)
+    cache["status:/resource:#{headers.hash}"] = 200
+    cache["headers:/resource:#{headers.hash}"] = {'Content-Type' => 'application/json'}
     schema = Heroics::Schema.new(SAMPLE_SCHEMA)
     link = Heroics::Link.new('https://example.com',
                              schema.resource('resource').link('list'),
@@ -395,4 +398,47 @@ class LinkTest < MiniTest::Unit::TestCase
                              schema.resource('resource').link('list'))
     assert_equal([1, 2], link.run.to_a)
   end
+
+  # Ensure that caching does not prevent pagination from working correctly.
+  # See https://github.com/heroku/platform-api/issues/16
+  def test_run_with_range_response_and_cache
+    Excon.stub(method: :get) do |request|
+      Excon.stubs.shift
+      {status: 206, headers: {'Content-Type' => 'application/json',
+                              'Content-Range' => 'id 1..2; max=200',
+                              'ETag' => 'second-page'},
+       body: MultiJson.dump([2])}
+    end
+
+    Excon.stub(method: :get) do |request|
+      Excon.stubs.shift
+      {status: 206, headers: {'Content-Type' => 'application/json',
+                              'Content-Range' => 'id 0..1; max=200',
+                              'Next-Range' => '201',
+                              'ETag' => 'first-page'},
+       body: MultiJson.dump([1])}
+    end
+
+    schema = Heroics::Schema.new(SAMPLE_SCHEMA)
+    link = Heroics::Link.new('https://example.com',
+                             schema.resource('resource').link('list'),
+                             cache: Moneta.new(:Memory))
+    assert_equal([1, 2], link.run.to_a)
+
+    Excon.stub(method: :get) do |request|
+      assert_equal('second-page', request[:headers]['If-None-Match'])
+      assert_equal('201', request[:headers]['Range'])
+      Excon.stubs.shift
+      {status: 304, headers: {'Content-Type' => 'application/json'}}
+    end
+
+    Excon.stub(method: :get) do |request|
+      assert_equal('first-page', request[:headers]['If-None-Match'])
+      assert_equal(nil, request[:headers]['Range'])
+      Excon.stubs.shift
+      {status: 304, headers: {'Content-Type' => 'application/json'}}
+    end
+
+    assert_equal([1, 2], link.run.to_a)
+  end
 end

data/test/naming_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'helper'
 
 class RubyNameTest < MiniTest::Unit::TestCase

data/test/resource_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'helper'
 
 class ResourceTest < MiniTest::Unit::TestCase

data/test/schema_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'helper'
 
 class SchemaTest < MiniTest::Unit::TestCase

data/test/version_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'helper'
 
 class VersionTest < MiniTest::Unit::TestCase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heroics
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - geemus
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-16 00:00:00.000000000 Z
+date: 2016-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
@@ -202,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A Ruby client generator for HTTP APIs described with a JSON schema