relax 0.2.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e9a6f87140b7758340b4a69166c801d0953f84bb0f820f23d3d817e281985d4c
+  data.tar.gz: a11fd29fd730571425e4c4160e04a199e94cbab9488babd5485e8012454a694c
+SHA512:
+  metadata.gz: 950f73a57eb7f5f7373c862e150a323814d5aba741b9ea4c62aed447f8cd9bb2dea48f8cb0213d8ee74c8e527853514bab77353ae7d16916b53c1c2a9508fcbb
+  data.tar.gz: e0e08e5b49c6b926d79e8910762e56cd73f0762b789fc22149c95038d6250bf0fec294205872979af7d71edbcc878ebe3ee999999f569e9adbad40ea490e8f09

data/.github/workflows/build.yml

@@ -0,0 +1,36 @@
+name: Build
+on:
+  - push
+  - pull_request
+
+jobs:
+  build:
+    name: Ruby ${{ matrix.ruby }} / Faraday ${{ matrix.faraday }}
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "2.6"
+          - "2.7"
+          - "3.0"
+          - "3.1"
+        faraday:
+          - "2.0"
+          - "2.7"
+
+    runs-on: "ubuntu-latest"
+
+    env:
+      BUNDLE_GEMFILE: gemfiles/faraday_${{ matrix.faraday }}.gemfile
+      RUBYOPT: "--disable-error_highlight"
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Setup project
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec

data/.gitignore

@@ -10,6 +10,7 @@ _yardoc
 bin
 coverage
 doc
+gemfiles/*.lock
 lib/bundler/man
 pkg
 rdoc

data/.rspec

@@ -1,2 +1 @@
---color
---format progress
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+script: bundle exec rspec
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "faraday-2.0" do
+  gem "faraday", "2.0.1"
+end
+
+appraise "faraday-2.7" do
+  gem "faraday", "2.7.1"
+end

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 0.3.0 - November 17, 2022
+
+* Support Faraday ~> 2.0
+* Require Ruby >= 2.6
+
+## 0.2.2 – June 7, 2012
+
+* Move default configuration into `Config`.
+* Add `Configurable` module to encapsulate `#config` and `#configure`.
+* Improve documentation and examples.
+
 ## 0.2.1 – May 30, 2012
 
 * Add a timeout configuration option and use it on the resource connection

data/README.md

@@ -1,5 +1,10 @@
 # Relax
 
+[![Build Status][travis-image]][travis]
+
+[travis]: http://travis-ci.org/tylerhunt/relax
+[travis-image]: https://secure.travis-ci.org/tylerhunt/relax.png
+
 A library of simple modules for building web service wrappers.
 
 
@@ -21,6 +26,11 @@ Relax is made up of three primary modules:
   * `Relax::Delegator` — delegates class methods to an instance of the client
     allowing for simple client usage
 
+It also includes a basic configuration class, `Relax::Config`, which defines
+some of client defaults and can used as the basis for your own custom
+configuration classes.
+
+
 ### Example
 
 ``` ruby
@@ -28,6 +38,8 @@ require 'relax'
 require 'faraday_middleware' # for JSON response parsing
 
 module Vimeo
+  extend Relax::Delegator[:client]
+
   class Client
     include Relax::Client
 
@@ -58,9 +70,9 @@ module Vimeo
     end
   end
 
-  extend Relax::Delegator
-
-  delegate_to Client
+  def self.client
+    @client ||= Client.new
+  end
 end
 
 Vimeo.user(ENV['VIMEO_USERNAME']).videos

data/examples/delicious.rb

@@ -1,19 +1,30 @@
+# This example shows:
+#
+#   - inheriting from Relax::Config and overriding Client#config to use it
+#   - customizing the resource to use basic auth and XML response parsing
+#   - instantiating multiple clients with distinct configurations
+#   - modifying a client instance endpoint to point to a different API
+
 require 'relax'
 require 'multi_xml'
 require 'faraday_middleware'
 
 module Delicious
-  module Config
+  class Config < Relax::Config
     attr :username, true
     attr :password, true
+
+    def initialize
+      super
+      self.base_uri = 'https://api.del.icio.us/v1'
+    end
   end
 
   class Client
     include Relax::Client
 
-    def initialize
-      config.base_uri = 'https://api.del.icio.us/v1'
-      config.extend(Config)
+    def config
+      @config ||= Config.new
     end
 
     def posts

data/examples/flickr.rb

@@ -1,9 +1,15 @@
+# This example shows:
+#
+#   - overriding the default configuration values in Client#initialize
+#   - extending the configuration with custom values using config.extend
+#   - overriding Resource#get to merge in custom parameters
+#   - customizing the resource to use JSON response parsing
+#   - providing a module-level client accessor without using delegation
+
 require 'relax'
 require 'faraday_middleware'
 
 module Flickr
-  extend Relax::Delegator[:client]
-
   module Config
     attr :api_key, true
   end
@@ -36,9 +42,7 @@ module Flickr
     end
 
     def connection
-      super do |builder|
-        builder.response(:json)
-      end
+      super { |builder| builder.response(:json) }
     end
   end
 
@@ -57,10 +61,10 @@ module Flickr
   end
 end
 
-Flickr.configure do |config|
+Flickr.client.configure do |config|
   config.api_key = ENV['FLICKR_API_KEY']
 end
 
-photos = Flickr.search.photos('ruby')
+photos = Flickr.client.search.photos('ruby')
 
 puts photos.first(10).collect { |photo| photo['title'] }

data/examples/vimeo.rb

@@ -1,3 +1,9 @@
+# This example shows:
+#
+#   - using Relax::Delegator to make the root module behave like a client
+#   - how to create resources that accept options for resource-level defaults
+#   - customizing the resource to use JSON response parsing
+
 require 'relax'
 require 'faraday_middleware'
 

data/gemfiles/faraday_2.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "faraday", "2.0.1"
+
+gemspec path: "../"

data/gemfiles/faraday_2.7.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "faraday", "2.7.1"
+
+gemspec path: "../"

data/lib/relax/client.rb

@@ -1,20 +1,5 @@
-require 'faraday'
-
 module Relax
   module Client
-    USER_AGENT = "Relax Ruby Gem Client #{Relax::VERSION}"
-    TIMEOUT = 60
-
-    def config
-      @config ||= Config.new.configure do |config|
-        config.adapter = Faraday.default_adapter
-        config.user_agent = USER_AGENT
-        config.timeout = TIMEOUT
-      end
-    end
-
-    def configure(&block)
-      config.configure(&block)
-    end
+    include Configurable
   end
 end

data/lib/relax/config.rb

@@ -1,13 +1,19 @@
+require 'faraday'
+
 module Relax
   class Config
+    USER_AGENT = "Relax Ruby Gem Client #{Relax::VERSION}"
+    TIMEOUT = 60
+
     attr :adapter, true
     attr :base_uri, true
     attr :timeout, true
     attr :user_agent, true
 
-    def configure
-      yield(self)
-      self
+    def initialize
+      self.adapter = Faraday.default_adapter
+      self.user_agent = USER_AGENT
+      self.timeout = TIMEOUT
     end
   end
 end

data/lib/relax/configurable.rb

@@ -0,0 +1,12 @@
+module Relax
+  module Configurable
+    def config
+      @config ||= Config.new
+    end
+
+    def configure
+      yield(config)
+      self
+    end
+  end
+end

data/lib/relax/version.rb

@@ -1,3 +1,3 @@
 module Relax
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/relax.rb

@@ -3,6 +3,7 @@ require 'relax/version'
 module Relax
   autoload :Client, 'relax/client'
   autoload :Config, 'relax/config'
+  autoload :Configurable, 'relax/configurable'
   autoload :Delegator, 'relax/delegator'
   autoload :Resource, 'relax/resource'
 end

data/relax.gemspec

@@ -1,17 +1,21 @@
 require './lib/relax/version'
 
-Gem::Specification.new do |gem|
-  gem.name = 'relax'
-  gem.version = Relax::VERSION
-  gem.summary = 'A flexible library for creating web service consumers.'
-  gem.homepage = 'http://github.com/tylerhunt/relax'
-  gem.author = 'Tyler Hunt'
+Gem::Specification.new do |spec|
+  spec.name = 'relax'
+  spec.version = Relax::VERSION
+  spec.authors = ['Tyler Hunt']
+  spec.summary = 'A flexible library for creating web service consumers.'
+  spec.homepage = 'http://github.com/tylerhunt/relax'
+  spec.license = 'MIT'
 
-  gem.add_dependency 'faraday', '~> 0.8.0'
-  gem.add_development_dependency 'rspec', '~> 2.6'
+  spec.required_ruby_version = '>= 2.6'
 
-  gem.files = `git ls-files`.split($\)
-  gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ['lib']
+  spec.add_dependency 'faraday', '~> 2.0'
+  spec.add_development_dependency 'rspec', '~> 3.12'
+  spec.add_development_dependency 'appraisal', '~> 2.4'
+
+  spec.files = `git ls-files`.split($\)
+  spec.executables = spec.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
 end

data/spec/relax/client_spec.rb

@@ -1,40 +1,24 @@
-require 'spec_helper'
-
-describe Relax::Client do
-  let(:client) { Class.new { include Relax::Client }.new }
-
-  subject { client }
+RSpec.describe Relax::Client do
+  subject(:client) { Class.new { include Relax::Client }.new }
 
   context '#config' do
     it 'returns an instance of Relax::Config' do
-      subject.config.should be_a(Relax::Config)
+      expect(client.config).to be_a Relax::Config
     end
 
     it 'memoizes the configuration' do
-      subject.config.should == subject.config
-    end
-
-    context 'defaults' do
-      subject { client.config }
-
-      its(:adapter) { should == Faraday.default_adapter }
-      its(:base_uri) { should be_nil }
-      its(:timeout) { should == 60 }
-      its(:user_agent) { should == "Relax Ruby Gem Client #{Relax::VERSION}" }
+      expect(client.config).to eq client.config
     end
   end
 
   context '#configure' do
     it 'yields an instance of the configuration' do
-      expect {
-        subject.configure do |config|
-          config.base_uri = 'http://api.example.com/v2'
-        end
-      }.to change(subject.config, :base_uri).to('http://api.example.com/v2')
+      expect { |block| client.configure &block }
+        .to yield_with_args(client.config)
     end
 
-    it 'returns the configuration' do
-      subject.configure { }.should == subject.config
+    it 'returns self' do
+      expect(client.configure {}).to eq client
     end
   end
 end

data/spec/relax/config_spec.rb

@@ -1,17 +1,38 @@
-require 'spec_helper'
+RSpec.describe Relax::Config do
+  {
+    USER_AGENT: "Relax Ruby Gem Client #{Relax::VERSION}",
+    TIMEOUT: 60
+  }.each do |constant, value|
+    context "::#{constant}" do
+      subject { described_class.const_get(constant) }
 
-describe Relax::Config do
-  context '#configure' do
-    it 'yields an instance of the configuration' do
-      expect {
-        subject.configure do |config|
-          config.base_uri = 'http://api.example.com/v2'
-        end
-      }.to change(subject, :base_uri).to('http://api.example.com/v2')
+      it { is_expected.to eq value }
     end
+  end
+
+  subject(:config) { described_class.new }
+
+  context '#adapter' do
+    it 'defaults to Faraday’s default adapter' do
+      expect(config.adapter).to eq Faraday.default_adapter
+    end
+  end
+
+  context '#base_uri' do
+    it 'defaults to nil' do
+      expect(config.base_uri).to be_nil
+    end
+  end
+
+  context '#adapter' do
+    it 'has a default value' do
+      expect(config.timeout).to eq 60
+    end
+  end
 
-    it 'returns the configuration' do
-      subject.configure { }.should == subject
+  context '#adapter' do
+    it 'has a default value' do
+      expect(config.user_agent).to eq "Relax Ruby Gem Client #{Relax::VERSION}"
     end
   end
 end

data/spec/relax/configurable_spec.rb

@@ -0,0 +1,24 @@
+RSpec.describe Relax::Configurable do
+  subject(:configurable) { Class.new { include Relax::Configurable }.new }
+
+  context '#config' do
+    it 'returns an instance of Relax::Config' do
+      expect(configurable.config).to be_a Relax::Config
+    end
+
+    it 'memoizes the configuration' do
+      expect(configurable.config).to eq configurable.config
+    end
+  end
+
+  context '#configure' do
+    it 'yields an instance of the configuration' do
+      expect { |block| configurable.configure &block }
+        .to yield_with_args(configurable.config)
+    end
+
+    it 'returns self' do
+      expect(configurable.configure {}).to eq configurable
+    end
+  end
+end

data/spec/relax/delegator_spec.rb

@@ -1,9 +1,7 @@
-require 'spec_helper'
-
-describe Relax::Delegator do
+RSpec.describe Relax::Delegator do
   let(:client) { Class.new { include Relax::Client } }
 
-  subject do
+  subject(:delegator) do
     Class.new do
       extend Relax::Delegator[:client]
 
@@ -13,19 +11,20 @@ describe Relax::Delegator do
     end
   end
 
-  before { subject.client = client.new }
+  before { delegator.client = client.new }
 
   context '.[]' do
     it 'accepts a client method name and returns a module' do
-      described_class[:client].should be_a(Module)
+      expect(described_class[:client]).to be_a Module
     end
   end
 
   context 'delegation' do
     Relax::Client.instance_methods.each do |method|
       it "delegates .#{method} to the client" do
-        subject.client.should_receive(method)
-        subject.send(method)
+        expect(delegator.client).to receive(method)
+
+        delegator.send method
       end
     end
   end

data/spec/relax/resource_spec.rb

@@ -1,6 +1,4 @@
-require 'spec_helper'
-
-describe Relax::Resource do
+RSpec.describe Relax::Resource do
   let(:client) do
     Class.new do
       include Relax::Client
@@ -13,7 +11,7 @@ describe Relax::Resource do
 
   let(:resource_class) { Class.new { include Relax::Resource } }
 
-  subject { resource_class.new(client) }
+  subject(:resource) { resource_class.new(client) }
 
   context '.new' do
     it 'accepts an options hash' do
@@ -22,42 +20,50 @@ describe Relax::Resource do
   end
 
   context '#connection' do
-    let(:connection) { subject.send(:connection) }
+    let(:connection) { resource.send(:connection) }
 
     it 'returns an instance of Faraday::Connection' do
-      connection.should be_a(Faraday::Connection)
+      expect(connection).to be_a Faraday::Connection
     end
 
     it 'uses the configured base URI as the URL' do
-      connection.url_prefix.should == URI.parse(client.config.base_uri)
+      expect(connection.url_prefix).to eq URI.parse(client.config.base_uri)
     end
 
     it 'uses the configured timeout' do
-      connection.options[:timeout].should == client.config.timeout
+      expect(connection.options[:timeout]).to eq client.config.timeout
     end
 
     it 'accepts an options hash to be passed to Faraday::Connection' do
       headers = { user_agent: "#{described_class} Test" }
-      connection = subject.send(:connection, headers: headers)
-      connection.headers['User-Agent'].should == headers[:user_agent]
+      connection = resource.send(:connection, headers: headers)
+
+      expect(connection.headers['User-Agent']).to eq headers[:user_agent]
     end
 
     it 'yields a builder to allow the middleware to be customized' do
-      subject.send(:connection) do |builder|
-        builder.use(Faraday::Response::Logger)
-      end.builder.handlers.should include(Faraday::Response::Logger)
+      connection = resource.send(:connection) { |builder|
+        builder.use Faraday::Response::Logger
+      }
+
+      expect(connection.builder.handlers).to include Faraday::Response::Logger
     end
   end
 
   context 'connection delegation' do
-    let(:connection) { stub(:connection) }
+    let(:connection) { double(:connection) }
 
-    before { subject.stub(:connection).and_return(connection) }
+    before do
+      allow(resource)
+        .to receive(:connection)
+        .and_return(connection)
+    end
 
     Faraday::Connection::METHODS.each do |method|
       it "delegates ##{method} to #connection" do
-        connection.should_receive(method)
-        subject.send(method)
+        expect(connection).to receive(method)
+
+        resource.send method
       end
     end
   end

data/spec/spec_helper.rb

@@ -5,7 +5,6 @@ Dir[File.expand_path('../support/**/*.rb', __FILE__)].each do |file|
 end
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 end

metadata

@@ -1,56 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: relax
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Tyler Hunt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-05-31 00:00:00.000000000 Z
+date: 2022-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
-description: 
-email: 
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".github/workflows/build.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -59,45 +71,49 @@ files:
 - examples/delicious.rb
 - examples/flickr.rb
 - examples/vimeo.rb
+- gemfiles/faraday_2.0.gemfile
+- gemfiles/faraday_2.7.gemfile
 - lib/relax.rb
 - lib/relax/client.rb
 - lib/relax/config.rb
+- lib/relax/configurable.rb
 - lib/relax/delegator.rb
 - lib/relax/resource.rb
 - lib/relax/version.rb
 - relax.gemspec
 - spec/relax/client_spec.rb
 - spec/relax/config_spec.rb
+- spec/relax/configurable_spec.rb
 - spec/relax/delegator_spec.rb
 - spec/relax/resource_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/tylerhunt/relax
-licenses: []
-post_install_message: 
+licenses:
+- MIT
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.24
-signing_key: 
-specification_version: 3
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
 summary: A flexible library for creating web service consumers.
 test_files:
 - spec/relax/client_spec.rb
 - spec/relax/config_spec.rb
+- spec/relax/configurable_spec.rb
 - spec/relax/delegator_spec.rb
 - spec/relax/resource_spec.rb
 - spec/spec_helper.rb