relax 0.1.3 → 0.2.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rvmrc
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+bin
+coverage
+doc
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/CHANGELOG.md

@@ -0,0 +1,63 @@
+# Changelog
+
+## 0.2.0 – Unreleased
+
+* Rewrote from scratch to be a smaller, simpler library
+
+## 0.1.3 – August 31, 2009
+
+* Added basic request logging
+* Updated to Relief 0.0.4
+
+## 0.1.2 – June 30, 2009
+
+* Added support for proxies
+* Added support for parameter name aliases
+* Added an option to force blank values to be used
+
+## 0.1.1 – June 3, 2009
+
+* Added support for tokenized URL parameters
+* Modified Service#authenticate to return self to allow chaining
+* Extended parsers to allow for custom parser classes (Nathaniel Bibler)
+
+## 0.1.0 – May 7, 2009
+
+* Rewrote the API to use a DSL interface
+* Replaced the embedded parsers with Relief
+
+## 0.0.7 – April 27, 2009
+
+* Added support for required request parameters
+
+## 0.0.6 – February 3, 2009
+
+* Fixed attribute-based parameters
+* Fixed an issue with `node_name` in the new parsers (Nathaniel Bibler)
+
+## 0.0.5 – October 20, 2008
+
+* Added support for multiple parsers (Nathaniel Bibler)
+* Added a REXML parser (Nathaniel Bibler)
+* Added a GitHub gemspec and a Rake task for regenerating it
+
+## 0.0.4 – November 17, 2007
+
+* Added support for custom Request parameter types
+
+## 0.0.3 – November 1, 2007
+
+* Fixed that parameter values defined in ancestors weren't passed to children
+* Added date and time parameter types to Response
+* Added an accessor for the raw XML to Response
+
+## 0.0.2 – October 10, 2007
+
+* Renamed API to Service
+* Added tutorial to the README
+* Added Rdoc documentation
+* Added support for custom Response parameter types
+
+## 0.0.1 – September 27, 2007
+
+* First public release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2007-2009 Tyler Hunt
+Copyright (c) 2007-2012 Tyler Hunt
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,80 @@
+# Relax
+
+A library of simple modules for building web service wrappers.
+
+
+## Usage
+
+Relax a toolkit of sorts, which makes it easier to write Faraday-based API
+Gems while still leaning heavily on the strengths of the Ruby language.
+
+### Overview
+
+Relax is made up of three primary modules:
+
+  * `Relax::Client` — forms the basis of a web service wrapper by storing the
+    configuration and serving as a factory for resources
+
+  * `Relax::Resource` — used to handle the actual web service connections and
+    help organize related endpoints
+
+  * `Relax::Delegator` — delegates class methods to an instance of the client
+    allowing for simple client usage
+
+### Example
+
+``` ruby
+require 'relax'
+require 'faraday_middleware' # for JSON response parsing
+
+module Vimeo
+  class Client
+    include Relax::Client
+
+    def initialize
+      config.base_uri = 'http://vimeo.com/api/v2'
+    end
+
+    def user(username)
+      Resources::User.new(self, username: username)
+    end
+  end
+
+  module Resource
+    include Relax::Resource
+
+    def connection
+      super { |builder| builder.response(:json) }
+    end
+  end
+
+  module Resources
+    class User
+      include Resource
+
+      def videos
+        get("#{@options[:username]}/videos.json").body
+      end
+    end
+  end
+
+  extend Relax::Delegator
+
+  delegate_to Client
+end
+
+Vimeo.user(ENV['VIMEO_USERNAME']).videos
+```
+
+See the [`examples` directory][examples] for more.
+
+[examples]: http://github.com/tylerhunt/relax/examples
+
+
+## Contributing
+
+1. Fork it.
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Commit your changes (`git commit -am 'Add some feature.'`).
+4. Push to the branch (`git push origin my-new-feature`).
+5. Create a new Pull Request.

data/Rakefile

@@ -1,53 +1,3 @@
-require 'rubygems'
-require 'rake'
-require 'rake/rdoctask'
-require 'spec/rake/spectask'
+#!/usr/bin/env rake
 
-begin
-  require 'jeweler'
-
-  Jeweler::Tasks.new do |gem|
-    gem.name = "relax"
-    gem.summary = %Q{A flexible library for creating web service consumers.}
-    gem.email = "tyler@tylerhunt.com"
-    gem.homepage = "http://github.com/tylerhunt/relax"
-    gem.authors = ["Tyler Hunt"]
-    gem.rubyforge_project = 'relax'
-
-    gem.add_dependency('rest-client', '~> 0.9.2')
-    gem.add_dependency('relief', '~> 0.0.4')
-
-    gem.add_development_dependency('jeweler', '~> 0.11.0')
-    gem.add_development_dependency('rspec', '~> 1.2.2')
-  end
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end
-
-task :default => :spec
-
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION.yml')
-    config = YAML.load(File.read('VERSION.yml'))
-    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
-  else
-    version = ""
-  end
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "relief #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('LICENSE*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'bundler/gem_tasks'

data/examples/delicious.rb

@@ -0,0 +1,61 @@
+require 'relax'
+require 'multi_xml'
+require 'faraday_middleware'
+
+module Delicious
+  module Config
+    attr :username, true
+    attr :password, true
+  end
+
+  class Client
+    include Relax::Client
+
+    def initialize
+      config.base_uri = 'https://api.del.icio.us/v1'
+      config.extend(Config)
+    end
+
+    def posts
+      @posts ||= Resources::Posts.new(self)
+    end
+  end
+
+  module Resource
+    include Relax::Resource
+
+    def connection
+      super do |builder|
+        builder.basic_auth(config.username, config.password)
+        builder.response(:xml)
+      end
+    end
+  end
+
+  module Resources
+    class Posts
+      include Resource
+
+      def recent(params={})
+        get('posts/recent', params).body['posts']['post']
+      end
+    end
+  end
+end
+
+delicious = Delicious::Client.new
+pinboard = Delicious::Client.new
+
+delicious.configure do |config|
+  config.username = ENV['DELICIOUS_USERNAME']
+  config.password = ENV['DELICIOUS_PASSWORD']
+end
+
+pinboard.configure do |config|
+  config.base_uri = 'https://api.pinboard.in/v1'
+  config.username = ENV['PINBOARD_USERNAME']
+  config.password = ENV['PINBOARD_PASSWORD']
+end
+
+puts delicious.posts.recent.first(10).collect { |post| post['href'] }
+puts pinboard.posts.recent.first(10).collect { |post| post['href'] }

data/examples/flickr.rb

@@ -0,0 +1,66 @@
+require 'relax'
+require 'faraday_middleware'
+
+module Flickr
+  extend Relax::Delegator[:client]
+
+  module Config
+    attr :api_key, true
+  end
+
+  class Client
+    include Relax::Client
+
+    def initialize
+      config.base_uri = 'http://api.flickr.com/services/rest/'
+      config.extend(Config)
+    end
+
+    def search
+      @search ||= Resources::Search.new(self)
+    end
+  end
+
+  module Resource
+    include Relax::Resource
+
+    def get(method, parameters={})
+      parameters.merge!(
+        method: method,
+        api_key: config.api_key,
+        format: :json,
+        nojsoncallback: 1
+      )
+
+      super(nil, parameters)
+    end
+
+    def connection
+      super do |builder|
+        builder.response(:json)
+      end
+    end
+  end
+
+  module Resources
+    class Search
+      include Resource
+
+      def photos(tags)
+        get('flickr.photos.search', tags: tags).body['photos']['photo']
+      end
+    end
+  end
+
+  def self.client
+    @client ||= Client.new
+  end
+end
+
+Flickr.configure do |config|
+  config.api_key = ENV['FLICKR_API_KEY']
+end
+
+photos = Flickr.search.photos('ruby')
+
+puts photos.first(10).collect { |photo| photo['title'] }

data/examples/vimeo.rb

@@ -0,0 +1,65 @@
+require 'relax'
+require 'faraday_middleware'
+
+module Vimeo
+  extend Relax::Delegator[:client]
+
+  class Client
+    include Relax::Client
+
+    def initialize
+      config.base_uri = 'http://vimeo.com/api/v2'
+    end
+
+    def user(username)
+      Resources::User.new(self, username: username)
+    end
+  end
+
+  module Resource
+    include Relax::Resource
+
+    def connection
+      super { |builder| builder.response(:json) }
+    end
+  end
+
+  module Resources
+    class User
+      include Resource
+
+      def info
+        get("#{@options[:username]}/info.json").body
+      end
+
+      def videos
+        get("#{@options[:username]}/videos.json").body
+      end
+
+      def likes
+        get("#{@options[:username]}/likes.json").body
+      end
+    end
+  end
+
+  def self.client
+    @client ||= Client.new
+  end
+end
+
+vimeo_user = Vimeo.user(ENV['VIMEO_USERNAME'])
+
+info = vimeo_user.info
+videos = vimeo_user.videos.first(10)
+likes = vimeo_user.likes.first(10)
+
+puts <<OUTPUT
+Name: #{info['display_name']}
+Location: #{info['location']}
+
+Videos:
+#{videos.collect { |post| "- #{post['title']}" }.join("\n")}
+
+Likes:
+#{likes.collect { |post| "- #{post['title']}" }.join("\n")}
+OUTPUT

data/lib/relax.rb

@@ -1,18 +1,8 @@
-require 'rubygems'
+require 'relax/version'
 
-gem 'relief', '~> 0.0.4'
-require 'relief'
-
-gem 'rest-client', '~> 0.9.2'
-require 'restclient'
-
-module Relax # :nodoc:
-  autoload :Action, 'relax/action'
-  autoload :Context, 'relax/context'
-  autoload :Contextable, 'relax/contextable'
-  autoload :Endpoint, 'relax/endpoint'
-  autoload :Instance, 'relax/instance'
-  autoload :Parameter, 'relax/parameter'
-  autoload :Performer, 'relax/performer'
-  autoload :Service, 'relax/service'
+module Relax
+  autoload :Client, 'relax/client'
+  autoload :Config, 'relax/config'
+  autoload :Delegator, 'relax/delegator'
+  autoload :Resource, 'relax/resource'
 end