heroics 0.0.23 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aa136b8dba59b471d2f401a6a1feced2da9aabd3
-  data.tar.gz: 7cec9ec603b4093a4c1c65888d2533eeb3920f0f
+SHA256:
+  metadata.gz: 935d4099ef19b7d1edd7f04bd8545d0f2a9d0a3dea2433005148854654a9efb9
+  data.tar.gz: afb94092e02a8ee403c4e2b2b7b0326c59f310376ce1175db13a18f185a56bdc
 SHA512:
-  metadata.gz: 3c949d3e1bd3743f76c81f32483f2ad68417a54f34421b7dac7256bb086c7fef773800b766ccbc5cef61f64d5017e2d993f8bf75cac19ca207c8ac4a0979a439
-  data.tar.gz: be86626f66f368408ca0887a3561982995c3e778801a882b4cfa6ffadee5156f57411c8f8b5326bf720b5d04c1f611d0c61187d20838ae13bc1684e8722d7856
+  metadata.gz: aa084cff8f5819cc23375f0764c878a44113bd094d1b47997438b2fa8e89e24f56e5ac1fa5dab9341fae077cc329e3d1fac4a5ec26a74e859bfeec50e2951a6b
+  data.tar.gz: 7417de326cf4f11b9f7dc73df4d4397fcfde7f130a34ed4b287226d1c0a536fee1e2f013a15ddb4c596453fc49167d6a218d630ac54059890ad0411e7d32412d

data/.github/workflows/check_changelog.yml

@@ -0,0 +1,12 @@
+name: Check Changelog
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Check that CHANGELOG is touched
+      run: |
+        cat $GITHUB_EVENT_PATH | jq .pull_request.title |  grep -i '\[\(\(changelog skip\)\|\(ci skip\)\)\]' ||  git diff remotes/origin/${{ github.base_ref }} --name-only | grep CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## 0.1.2
+
+- Add support for Ruby 3.0 (https://github.com/interagent/heroics/pull/101)
+
+## 0.1.1
+
+- Add status codes configuration (https://github.com/interagent/heroics/pull/96)
+
+## 0.1.0
+
+- Introduced rate throttling integration point (https://github.com/interagent/heroics/pull/95)

data/Rakefile

@@ -3,7 +3,6 @@ require "rake/testtask"
 
 Rake::TestTask.new do |task|
   task.verbose = true
-  task.ruby_opts << '-r turn/autorun'
   task.ruby_opts << '-I test'
   task.test_files = FileList['test/**/*_test.rb', 'test/**/*_spec.rb']
 end

data/bin/heroku-api

@@ -2,6 +2,7 @@
 
 require 'heroics'
 require 'netrc'
+require 'moneta'
 
 netrc = Netrc.read
 username, token = netrc['api.heroku.com']

data/heroics.gemspec

@@ -20,16 +20,16 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep('^(test|spec|features)/')
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'minitest', '4.7.5'
-  spec.add_development_dependency 'moneta'
   spec.add_development_dependency 'netrc'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'turn'
   spec.add_development_dependency 'yard'
   spec.add_development_dependency 'pry'
 
   spec.add_dependency 'erubis', '~> 2.0'
   spec.add_dependency 'excon'
   spec.add_dependency 'multi_json', '>= 1.9.2'
+  spec.add_dependency 'moneta'
+  spec.add_dependency 'webrick'
 end

data/lib/heroics.rb

@@ -4,6 +4,7 @@ require 'erubis'
 require 'excon'
 require 'multi_json'
 require 'uri'
+require 'webrick'
 require 'zlib'
 
 # Heroics is an HTTP client for an API described by a JSON schema.

data/lib/heroics/configuration.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
 module Heroics
+  module NullRateLimit
+    def self.call
+      yield
+    end
+  end
+
   # Attempts to load configuration, provides defaults, and provide helpers to access that data
   class Configuration
     attr_reader :base_url,
@@ -22,7 +28,8 @@ module Heroics
       @options = {}
       @options[:cache] = 'Moneta.new(:Memory)'
       @options[:default_headers] = {}
-
+      @options[:rate_throttle] = NullRateLimit
+      @options[:status_codes] = []
       @ruby_name_replacement_patterns = { /[\s-]+/ => '_' }
 
       yield self if block_given?
@@ -57,5 +64,13 @@ module Heroics
       raise "Must provide a hash of replacements" unless patterns.is_a?(Hash)
       @ruby_name_replacement_patterns = patterns
     end
+
+    def rate_throttle=(rate_throttle)
+      @options[:rate_throttle] = rate_throttle
+    end
+
+    def acceptable_status_codes=(status_codes)
+      @options[:status_codes] = status_codes
+    end
   end
 end

data/lib/heroics/link.rb

@@ -18,6 +18,8 @@ module Heroics
       @link_schema = link_schema
       @default_headers = options[:default_headers] || {}
       @cache = options[:cache] || {}
+      @rate_throttle = options[:rate_throttle] || Heroics::Configuration.defaults.options[:rate_throttle]
+      @status_codes = options[:status_codes] || Heroics::Configuration.defaults.options[:status_codes]
     end
 
     # Make a request to the server.
@@ -103,12 +105,18 @@ module Heroics
 
     def request_with_cache(connection, options)
       options[:expects] << 304
+      @status_codes.each do |code|
+        options[:expects] << code
+      end
       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)
+
+      response = @rate_throttle.call do
+        connection.request(options)
+      end
 
       if response.status == 304
         body = @cache["data:#{cache_key}"]

data/lib/heroics/schema.rb

@@ -244,7 +244,7 @@ module Heroics
                            [value['$ref'], key]
                          end]
       parameters.map do |parameter|
-        definition_name = URI.unescape(parameter[2..-3])
+        definition_name = ::URI::DEFAULT_PARSER.unescape(parameter[2..-3])
         if definitions.has_key?(definition_name)
           definitions[definition_name]
         else
@@ -273,7 +273,7 @@ module Heroics
     def resolve_parameter_details(parameters)
       parameters.map do |parameter|
         # URI decode parameters and strip the leading '{(' and trailing ')}'.
-        parameter = URI.unescape(parameter[2..-3])
+        parameter = ::URI::DEFAULT_PARSER.unescape(parameter[2..-3])
 
         # Split the path into components and discard the leading '#' that
         # represents the root of the schema.
@@ -334,7 +334,7 @@ module Heroics
     # @return [String] The formatted parameter.
     def format_parameter(parameter)
       formatted_parameter = parameter.instance_of?(Time) ? iso_format(parameter) : parameter.to_s
-      URI.escape formatted_parameter
+      WEBrick::HTTPUtils.escape formatted_parameter
     end
 
     # Convert a time to an ISO 8601 combined data and time format.

data/lib/heroics/version.rb

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

data/lib/heroics/views/client.erb

@@ -9,6 +9,7 @@
 
 require 'heroics'
 require 'uri'
+require 'moneta'
 
 module <%= @module_name %>
   # Get a Client configured to use HTTP Basic or header-based authentication.

metadata

@@ -1,30 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: heroics
 version: !ruby/object:Gem::Version
-  version: 0.0.23
+  version: 0.1.2
 platform: ruby
 authors:
 - geemus
 - jkakar
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-19 00:00:00.000000000 Z
+date: 2021-01-27 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'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -40,7 +40,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.7.5
 - !ruby/object:Gem::Dependency
-  name: moneta
+  name: netrc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -54,7 +54,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: netrc
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -68,7 +68,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,7 +82,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: turn
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -96,27 +96,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: erubis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '2.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: excon
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -124,21 +124,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: erubis
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.9.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.9.2
 - !ruby/object:Gem::Dependency
-  name: excon
+  name: moneta
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -152,19 +152,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: webrick
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.2
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.2
+        version: '0'
 description: A Ruby client generator for HTTP APIs described with a JSON schema
 email:
 - geemus@gmail.com
@@ -175,8 +175,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/check_changelog.yml"
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - CONTRIBUTORS.md
 - Gemfile
@@ -205,7 +207,7 @@ homepage: https://github.com/interagent/heroics
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -220,9 +222,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A Ruby client generator for HTTP APIs described with a JSON schema
 test_files: []