relax 0.2.1 → 0.2.2

data/.travis.yml

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

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 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/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/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.2.2'
 end

data/relax.gemspec

@@ -7,6 +7,8 @@ Gem::Specification.new do |gem|
   gem.homepage = 'http://github.com/tylerhunt/relax'
   gem.author = 'Tyler Hunt'
 
+  gem.required_ruby_version = '>= 1.9'
+
   gem.add_dependency 'faraday', '~> 0.8.0'
   gem.add_development_dependency 'rspec', '~> 2.6'
 

data/spec/relax/client_spec.rb

@@ -13,15 +13,6 @@ describe Relax::Client do
     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}" }
-    end
   end
 
   context '#configure' do
@@ -33,8 +24,8 @@ describe Relax::Client do
       }.to change(subject.config, :base_uri).to('http://api.example.com/v2')
     end
 
-    it 'returns the configuration' do
-      subject.configure { }.should == subject.config
+    it 'returns self' do
+      subject.configure { }.should == client
     end
   end
 end

data/spec/relax/config_spec.rb

@@ -1,17 +1,25 @@
 require 'spec_helper'
 
 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')
+  {
+    USER_AGENT: "Relax Ruby Gem Client #{Relax::VERSION}",
+    TIMEOUT: 60
+  }.each do |constant, value|
+    context "::#{constant}" do
+      subject { described_class.const_get(constant) }
+
+      it { should == value }
     end
+  end
+
+  context '.new' do
+    subject { described_class.new }
 
-    it 'returns the configuration' do
-      subject.configure { }.should == subject
+    context 'defaults' do
+      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}" }
     end
   end
 end

data/spec/relax/configurable_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Relax::Configurable do
+  let(:configurable) { Class.new { include Relax::Configurable }.new }
+
+  subject { configurable }
+
+  context '#config' do
+    it 'returns an instance of Relax::Config' do
+      subject.config.should be_a(Relax::Config)
+    end
+
+    it 'memoizes the configuration' do
+      subject.config.should == subject.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')
+    end
+
+    it 'returns self' do
+      subject.configure { }.should == configurable
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: relax
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-31 00:00:00.000000000 Z
+date: 2012-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -51,6 +51,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -62,12 +63,14 @@ files:
 - 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
@@ -82,7 +85,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -98,6 +101,7 @@ 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