wrest 0.1.1 → 0.1.2

data/CHANGELOG

@@ -13,7 +13,7 @@ Features under a numbered section are complete and available in the Wrest gem.
  * 304/ETag response caching
  * Keep-alive support for libcurl
 
-== Current
+== 0.1.1
  * Multipart post and put using Net::Http
 
 == 0.1.0

data/README.rdoc

@@ -1,6 +1,6 @@
-= Wrest 0.1.1
+= Wrest 0.1.2
 
-(c) Copyright 2009 {Sidu Ponnappa}[http://blog.sidu.in]. All Rights Reserved.
+(c) Copyright 2009-2010 {Sidu Ponnappa}[http://blog.sidu.in]. All Rights Reserved.
 
 Wrest is a ruby REST client library which
 * allows allows you to quickly build object oriented wrappers around any web service 

data/Rakefile

@@ -10,11 +10,11 @@
 # Note that some optional libraries/gems that the build (not Wrest itself) uses may not be available on all implementations of Ruby.
 puts "Building on Ruby #{RUBY_VERSION}, #{RUBY_RELEASE_DATE}, #{RUBY_PLATFORM}"
 
-if Object.const_defined?('RAILS_ROOT')
+if Object.const_defined?('RAILS_ROOT') || Object.const_defined?('Rails') 
   require File.dirname(__FILE__) + '/../../../config/environment'
 else
   require 'rubygems'
-  gem 'rspec'
+  gem 'rspec', '= 1.3.0'
   require 'rake'
   require 'spec'
   require 'spec/rake/spectask'
@@ -27,17 +27,18 @@ else
 end
 
 desc 'Default: run spec tests.'
-task :default => 'spec:unit'
+task :default => 'rspec:unit'
+task :spec => 'rspec:unit'
 
-namespace :spec do
+namespace :rspec do
   desc "Run all unit specs"
   Spec::Rake::SpecTask.new(:unit) do |task|
     task.spec_files = FileList['spec/unit/wrest/**/*_spec.rb']
     task.spec_opts = ['--options', 'spec/spec.opts']
   end
   
-  desc "Run all live functional specs"
-  Spec::Rake::SpecTask.new(:functional) do |task|
+  desc "Run all live functional specs - requires sample_rails_app running at 3000 in test environment"
+  Spec::Rake::SpecTask.new(:functional) do |task| 
     task.spec_files = FileList['spec/functional/wrest/**/*_spec.rb']
     task.spec_opts = ['--options', 'spec/spec.opts']
   end
@@ -87,11 +88,11 @@ begin
     gemspec.homepage = "http://github.com/kaiwren/wrest"
     gemspec.has_rdoc = true
     gemspec.rubyforge_project = 'wrest'
-    gemspec.executables = ['wrest', 'jwrest']
+    gemspec.executables = ['wrest']
     gemspec.require_path = "lib"
     gemspec.files.exclude *['.gitignore', 'spec/functional']
     gemspec.test_files.exclude *['.gitignore', 'spec/functional', 'examples']
-    gemspec.add_dependency('activesupport', '>= 2.3.5')
+    gemspec.add_dependency('activesupport', '= 2.3.8')
     case RUBY_PLATFORM
     when /java/
       gemspec.add_dependency('json-jruby', '>= 1.1.3')
@@ -103,8 +104,8 @@ begin
     end
   end
 rescue LoadError
-  puts "Jeweler not available. Install it with: gem install technicalpickles-jeweler -s http://gems.github.com"
-  puts "If you're using JRuby and are having trouble installing jeweler, try installing the git (gem install git) and rubyforge (gem install rubyforge) gems by hand. Also remember to update gems itself (jruby -S gem update --system)."
+  puts "Jeweler not available. Install it with: gem install jeweler"
+  puts "If you're using JRuby and are having trouble installing jeweler, try installing the git (gem install git) and rubyforge (gem install rubyforge) gems by hand. Also remember to update gems itself (jruby -S gem update --system)." if RUBY_PLATFORM =~ /java/
 end
 
 begin

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 1
+:patch: 2
 :minor: 1
 :major: 0

data/examples/imgur_multipart.rb

@@ -0,0 +1,24 @@
+# Copyright 2009 - 2010 Sidu Ponnappa
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed under the License
+# is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
+
+require 'pp'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/wrest")
+
+# See http://code.google.com/p/imgur-api
+imgur_key = 'f6561f62e13422bb25a1e738e9927d3b' # use your own key, this one is fake
+file_path = 'VoA10.png'
+
+# Using the eminently sensible Base64 encoded imgur file upload API
+pp 'http://imgur.com/api/upload.xml'.to_uri.post_form(:image => [IO.read(file_path)].pack('m'), :key => imgur_key).deserialise
+
+# If an API requires multipart posts - like the Facebook API - you can do that too
+require 'wrest/multipart'
+File.open(file_path) do |file|
+  pp 'http://imgur.com/api/upload.xml'.to_uri.post_multipart(:image => UploadIO.new(file, "image/png", file_path), :key => imgur_key).deserialise
+end

data/lib/wrest.rb

@@ -7,7 +7,7 @@
 # See the License for the specific language governing permissions and limitations under the License.
 
 require 'rubygems'
-gem 'activesupport', '>= 2.3.5'
+gem 'activesupport', '=2.3.8'
 
 require 'net/http'
 require 'net/https'

data/lib/wrest/components/container.rb

@@ -116,7 +116,7 @@ module Wrest::Components
       #
       # This method can be overidden should you need a different name.
       def element_name
-        @element_name ||= self.name.demodulize.underscore.underscore
+        @element_name ||= ActiveSupport::Inflector.demodulize(self.name).underscore.underscore
       end
     end
 

data/lib/wrest/multipart.rb

@@ -9,8 +9,8 @@
 
 begin
   gem 'multipart-post', '>= 1.0'
-rescue Gem::LoadError
-  Wrest.logger.debug "Multipart Post >= 1.0 not found. Multipart Post is necessary to be able to post multipart. To install Multipart Post run `sudo gem install multipart-post`"
+rescue Gem::LoadError => e
+  Wrest.logger.debug "Multipart Post >= 1.0 not found. Multipart Post is necessary to be able to post multipart. To install Multipart Post run 'sudo gem install multipart-post'"
   raise e
 end
 

data/lib/wrest/native/get.rb

@@ -12,6 +12,7 @@ module Wrest::Native
     def initialize(wrest_uri, parameters = {}, headers = {}, options = {})
       follow_redirects = options[:follow_redirects]
       options[:follow_redirects] = (follow_redirects == nil ? true : follow_redirects)
+      options[:cache_store] ||= {}
       super(
             wrest_uri, 
             Net::HTTP::Get, 
@@ -21,5 +22,30 @@ module Wrest::Native
             options
           )
     end
+
+    def invoke_with_cache_check
+      cached_response = get_cached_response
+      if cached_response.nil? then
+        response = invoke_without_cache_check
+        cache_response(response)
+        response
+      else
+        cached_response
+      end
+    end
+
+    def get_cached_response
+      response = nil
+      if cache_store.has_key?(@uri)
+        response = cache_store.fetch(@uri)
+      end
+      response
+    end
+
+    def cache_response(response)
+      cache_store[@uri] = response
+    end
+
+    alias_method_chain :invoke, :cache_check
   end
 end

data/lib/wrest/native/request.rb

@@ -13,7 +13,7 @@ module Wrest::Native
   # or Wrest::Native::Get etc. instead.
   class Request
     attr_reader :http_request, :uri, :body, :headers, :username, :password, :follow_redirects,
-                :follow_redirects_limit, :follow_redirects_count, :timeout, :connection, :parameters
+                :follow_redirects_limit, :follow_redirects_count, :timeout, :connection, :parameters, :cache_store
     # Valid tuples for the options are:
     #   :username => String, defaults to nil
     #   :password => String, defaults to nil
@@ -31,6 +31,7 @@ module Wrest::Native
     #               in the event of a connection failing to open. Defaulted to 60 by Uri#create_connection.
     #   :connection => The HTTP Connection object to use. This is how a keep-alive connection can be
     #                  used for multiple requests.
+    #   :cache_store => The object which should be used as cache store for cacheable responses
     def initialize(wrest_uri, http_request_klass, parameters = {}, body = nil, headers = {}, options = {})
       @uri = wrest_uri
       @headers = headers.stringify_keys
@@ -45,6 +46,7 @@ module Wrest::Native
       @timeout = @options[:timeout]
       @connection = @options[:connection]
       @http_request = self.build_request(http_request_klass, @uri, @parameters, @headers)
+      @cache_store = options[:cache_store]
     end
 
     # Makes a request and returns a Wrest::Native::Response. 

data/lib/wrest/version.rb

@@ -12,11 +12,11 @@ module Wrest
     unless defined? MAJOR
       MAJOR  = 0
       MINOR  = 1
-      TINY   = 1
+      TINY   = 2
 
       STRING = [MAJOR, MINOR, TINY].join('.')
 
       SUMMARY = "wrest version #{STRING}"
     end
   end
-end
+end

data/spec/unit/wrest/native/get_spec.rb

@@ -0,0 +1,64 @@
+# Copyright 2009 Sidu Ponnappa
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed under the License
+# is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
+
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Wrest::Native::Get do
+  describe "caching" do
+  
+    before :each do
+      @request_uri = 'http://localhost/foo'.to_uri
+      @cache = Hash.new
+      @get = Wrest::Native::Get.new(@request_uri, {},{},{:cache_store => @cache})
+    end
+
+    describe "dependencies" do
+      before :each do
+        @get.stub!(:invoke_without_cache_check).and_return(build_ok_response)
+      end
+
+      it "should call get_cached_response before making actual request" do
+        @get.should_receive(:get_cached_response)
+        @get.invoke
+      end
+
+      it "should call cache_response after calling invoke method for fresh request" do
+        @get.should_receive(:get_cached_response).and_return(nil)
+        @get.should_receive(:cache_response)
+        @get.invoke
+      end
+
+      it "should check if response already exists cache before making a request" do
+        @cache.should_receive(:has_key?).with(@request_uri)
+        @get.invoke
+      end
+    end
+    it "should call invoke_without_cache_check if response does not exist in cache" do
+      @cache.should_receive(:has_key?).with(@request_uri).and_return(false)
+      @get.should_receive(:invoke_without_cache_check)
+      @get.invoke
+    end
+
+    it "should not call invoke_without_cache_check if response exists in cache" do
+      @cache.should_receive(:has_key?).with(@request_uri).and_return(true)
+      @cache.should_receive(:fetch).with(@request_uri).and_return(build_ok_response)
+      @get.should_not_receive(:invoke_without_cache_check)
+      @get.invoke
+    end
+
+    it "should store response in cache if it did not exist in cache" do
+      response = build_ok_response
+      @cache.should_receive(:has_key?).with(@request_uri).and_return(false)
+      @get.should_receive(:invoke_without_cache_check).and_return(response)
+      @cache.should_receive(:[]=).with(@request_uri,response)
+      @get.invoke
+    end
+
+  end
+end

data/wrest.gemspec

@@ -5,14 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{wrest}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sidu Ponnappa"]
-  s.date = %q{2010-04-22}
+  s.date = %q{2010-07-27}
+  s.default_executable = %q{wrest}
   s.description = %q{Wrest is a HTTP and REST client library which allows you to quickly build well encapsulated, object oriented wrappers around any web service.}
   s.email = %q{ckponnappa@gmail.com}
-  s.executables = ["wrest", "jwrest"]
+  s.executables = ["wrest"]
   s.extra_rdoc_files = [
     "README.rdoc"
   ]
@@ -24,9 +25,9 @@ Gem::Specification.new do |s|
      "bin/jwrest",
      "bin/wrest",
      "bin/wrest_shell.rb",
-     "examples/aws_simpledb.rb",
      "examples/delicious.rb",
      "examples/facebook.rb",
+     "examples/imgur_multipart.rb",
      "examples/keep_alive.rb",
      "examples/redirection.rb",
      "examples/twitter.rb",
@@ -107,6 +108,7 @@ Gem::Specification.new do |s|
      "spec/unit/wrest/curl/request_spec.rb",
      "spec/unit/wrest/curl/response_spec.rb",
      "spec/unit/wrest/http/response_spec.rb",
+     "spec/unit/wrest/native/get_spec.rb",
      "spec/unit/wrest/native/redirection_spec.rb",
      "spec/unit/wrest/native/request_spec.rb",
      "spec/unit/wrest/native/response_spec.rb",
@@ -120,7 +122,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{wrest}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{REST client library for Ruby.}
   s.test_files = [
     "spec/custom_matchers/custom_matchers.rb",
@@ -140,6 +142,7 @@ Gem::Specification.new do |s|
      "spec/unit/wrest/curl/request_spec.rb",
      "spec/unit/wrest/curl/response_spec.rb",
      "spec/unit/wrest/http/response_spec.rb",
+     "spec/unit/wrest/native/get_spec.rb",
      "spec/unit/wrest/native/redirection_spec.rb",
      "spec/unit/wrest/native/request_spec.rb",
      "spec/unit/wrest/native/response_spec.rb",
@@ -153,15 +156,15 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.5"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, ["= 2.3.8"])
       s.add_runtime_dependency(%q<json>, [">= 1.1.3"])
     else
-      s.add_dependency(%q<activesupport>, [">= 2.3.5"])
+      s.add_dependency(%q<activesupport>, ["= 2.3.8"])
       s.add_dependency(%q<json>, [">= 1.1.3"])
     end
   else
-    s.add_dependency(%q<activesupport>, [">= 2.3.5"])
+    s.add_dependency(%q<activesupport>, ["= 2.3.8"])
     s.add_dependency(%q<json>, [">= 1.1.3"])
   end
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wrest
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Sidu Ponnappa
@@ -9,34 +15,45 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-22 00:00:00 +05:30
-default_executable: 
+date: 2010-07-27 00:00:00 +05:30
+default_executable: wrest
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        version: 2.3.5
-    version: 
+        hash: 19
+        segments: 
+        - 2
+        - 3
+        - 8
+        version: 2.3.8
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: json
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 1
+        - 3
         version: 1.1.3
-    version: 
+  type: :runtime
+  version_requirements: *id002
 description: Wrest is a HTTP and REST client library which allows you to quickly build well encapsulated, object oriented wrappers around any web service.
 email: ckponnappa@gmail.com
 executables: 
 - wrest
-- jwrest
 extensions: []
 
 extra_rdoc_files: 
@@ -49,9 +66,9 @@ files:
 - bin/jwrest
 - bin/wrest
 - bin/wrest_shell.rb
-- examples/aws_simpledb.rb
 - examples/delicious.rb
 - examples/facebook.rb
+- examples/imgur_multipart.rb
 - examples/keep_alive.rb
 - examples/redirection.rb
 - examples/twitter.rb
@@ -132,6 +149,7 @@ files:
 - spec/unit/wrest/curl/request_spec.rb
 - spec/unit/wrest/curl/response_spec.rb
 - spec/unit/wrest/http/response_spec.rb
+- spec/unit/wrest/native/get_spec.rb
 - spec/unit/wrest/native/redirection_spec.rb
 - spec/unit/wrest/native/request_spec.rb
 - spec/unit/wrest/native/response_spec.rb
@@ -150,21 +168,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: wrest
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: REST client library for Ruby.
@@ -186,6 +210,7 @@ test_files:
 - spec/unit/wrest/curl/request_spec.rb
 - spec/unit/wrest/curl/response_spec.rb
 - spec/unit/wrest/http/response_spec.rb
+- spec/unit/wrest/native/get_spec.rb
 - spec/unit/wrest/native/redirection_spec.rb
 - spec/unit/wrest/native/request_spec.rb
 - spec/unit/wrest/native/response_spec.rb

data/examples/aws_simpledb.rb

@@ -1,60 +0,0 @@
-# Copyright 2009 Sidu Ponnappa
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
-# Unless required by applicable law or agreed to in writing, software distributed under the License
-# is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and limitations under the License.
-
-require File.expand_path(File.dirname(__FILE__) + "/../lib/wrest")
-require 'pp'
-require 'openssl'
-require 'time'
-require "base64"
-
-Wrest.logger = Logger.new(STDOUT)
-Wrest.logger.level = Logger::DEBUG  # Set this to Logger::INFO or higher to disable request logging
-
-# AWS SDB API Reference
-# http://docs.amazonwebservices.com/AmazonSimpleDB/latest/DeveloperGuide/index.html?SDB_API.html
-
-module SimpleDB
-  Config = {
-    :aws_access_key_id => 'AKIAJOTOWFTQ6FRQIZZA',
-    :aws_secret_access_key => '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'
-  }
-  Uri = "https://sdb.amazonaws.com".to_uri
-  Digest  = OpenSSL::Digest::Digest.new('sha1')
-  
-  extend self
-  def invoke(action)
-    options = {
-      'Action' => action,
-      'AWSAccessKeyId' => SimpleDB::Config[:aws_access_key_id],
-      'DomainName' => 'LEDev',
-      'SignatureVersion' => '2',
-      'SignatureMethod' => 'HmacSHA256',
-      'Timestamp' => Time.now.iso8601,
-      'Version' => '2009-04-15'
-    }
-    Uri.get(options.merge('Signature' => signature_for(options)))
-  end
-  
-  # http://docs.amazonwebservices.com/AmazonSimpleDB/latest/DeveloperGuide/index.html?REST_RESTAuth.html
-  def signature_for(options)
-    data = [
-      "GET",
-      "sdb.amazonaws.com",
-      options.keys.sort.map{|k| "#{k}=#{CGI::escape(options[k])}"}.join('&')
-    ].join("\n")
-    CGI::escape(Base64.encode64(OpenSSL::HMAC.digest(Digest, Config[:aws_secret_access_key], data)))
-  end
-  
-  def list_domains
-    invoke('ListDomains').body
-  end
-end
-
-
-pp SimpleDB.list_domains