evoke_client 0.2.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Justin Knowlden, Thumble Monks
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,34 @@
+# Evoke Client
+
+evoke-client is a simple rest-client utility for allowing your application to converse with the [Evoke Service](http://evoke.thumblemonks.com). The source code for [Evoke can be found on GitHub](http://github.com/thumblemonks/evoke) along with what Evoke is intended for.
+
+### Usage
+
+    evoke = Evoke.new(:url => 'http://example.com/users/unsubscribe', :callback_at => (Time.now + 86400))
+    evoke.save
+    
+    # What happens if save fails
+
+### Configuration
+
+By default, evoke-client tries to talk to the Evoke service, generously hosted by Thumble Monks :) Because Evoke itself is open source and able to be run by you anywhere you want it to, the only real configuration parameters are for the hostname and port that you want evoke-client to talk to Evoke on. For instance, when we use Evoke in our projects, we may want to test with a local instance while doing development.
+
+To modify host and port, just set the following:
+
+    Evoke.host = "example.com"
+    Evoke.port = "4567"
+    # Choosing 4567 because Evoke is written for Sinatra
+
+### Installation
+
+    gem install thumblemonks-evoke_client
+
+#### Dependencies
+
+These should be automatically installed when you install evoke_client
+
+* [rest-client](http://github.com/adamwiggins/rest-client)
+
+## License
+
+MIT, baby! (see file named MIT-LICENSE)

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default task: run all tests'
+task :default => [:test]
+
+task(:set_test_env) { ENV['APP_ENV'] ||= 'test' }
+
+task(:environment) { }
+
+task :test => [:set_test_env]
+desc 'Run all tests'
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/evoke_client.gemspec

@@ -0,0 +1,35 @@
+Gem::Specification.new do |s|
+  s.name     = "evoke_client"
+  s.version  = "0.2.0"
+  s.date     = "2009-06-07"
+  s.summary  = "Rest client interface for talking REST to the evoke service"
+  s.email    = %w[gus@gusg.us]
+  s.homepage = "http://github.com/thumblemonks/evoke_client"
+  s.description = "Rest client interface for talking REST to the evoke service"
+  s.authors  = %w[Justin\ Knowlden]
+  s.post_install_message = %q{Choosy wizards choose Thumble Monks.}
+
+  s.has_rdoc = false
+  s.rdoc_options = ["--main", "README.markdown"]
+  s.extra_rdoc_files = ["README.markdown"]
+
+  s.add_dependency("rest-client", [">= 0.9.2"])
+
+  # run git ls-files to get an updated list
+  s.files = %w[
+    MIT-LICENSE
+    README.markdown
+    Rakefile
+    evoke_client.gemspec
+    lib/evoke_client.rb
+    lib/evoke_client/base.rb
+    lib/evoke_client/stub.rb
+    lib/query_string.rb
+    shoulda_macros/rest_client.rb
+  ]
+  
+  s.test_files = %w[
+    test/evoke_client_test.rb
+    test/test_helper.rb
+  ]
+end

data/lib/evoke_client.rb

@@ -0,0 +1,33 @@
+require 'query_string'
+require 'evoke_client/base'
+require 'evoke_client/stub'
+
+class Evoke
+  class ConnectionRefused < Exception; end
+
+  # Configuration
+
+  def self.test?; @test == true; end
+  def self.test=(setting) @test = setting; end
+
+  def self.host; @host || 'evoke.thumblemonks.com'; end
+  def self.host=(host) @host = host; end
+
+  def self.port; @port; end
+  def self.port=(port) @port = port; end
+
+  def self.host_and_port
+    [host, port].compact.join(':')
+  end
+
+  # Logic
+
+  def self.create_or_update!(*args)
+    prepare(*args).save
+  end
+
+  def self.prepare(*args)
+    (test? ? EvokeClient::Stub : EvokeClient::Base).new(*args)
+  end
+  
+end

data/lib/evoke_client/base.rb

@@ -0,0 +1,23 @@
+require 'restclient'
+
+module EvokeClient
+  class Base
+    attr_reader :params, :headers
+
+    def initialize(params={})
+      @evoke = ::RestClient::Resource.new("http://#{Evoke.host_and_port}/callbacks")
+      @params = params
+      @params[:callback_at] = @params[:callback_at].utc if @params[:callback_at]
+      @params[:data] = @params[:data].to_query_string if @params[:data]
+    end
+
+    def save
+      @evoke[params[:guid]].get
+      @evoke[params[:guid]].put(@params)
+    rescue ::RestClient::ResourceNotFound
+      @evoke.post(@params)
+    rescue Errno::ECONNREFUSED
+      raise Evoke::ConnectionRefused, "Connection refused while connecting to #{Evoke.host_and_port}"
+    end
+  end # Base
+end # EvokeClient

data/lib/evoke_client/stub.rb

@@ -0,0 +1,7 @@
+module EvokeClient
+  class Stub
+    def initialize(params={}); end
+
+    def save; end
+  end # Stub
+end # EvokeClient

data/lib/query_string.rb

@@ -0,0 +1,16 @@
+module EvokeClient
+  module Hash
+    def to_query_string
+      map do |key, val|
+        "#{key}=#{val}"
+      end.join('&')
+    end
+  end # Hash
+
+  module String
+    alias_method :to_query_string, :to_s
+  end # String
+end # EvokeClient
+
+Hash.instance_eval { include EvokeClient::Hash }
+String.instance_eval { include EvokeClient::String }

data/shoulda_macros/rest_client.rb

@@ -0,0 +1,16 @@
+module EvokeClient
+  module RestClient
+    module Shoulda
+      def expect_restful_request(method, *args)
+        ::RestClient::Resource.any_instance.expects(method).with(*args)
+      end
+
+      def expect_restful_request_failure(method, *raises)
+        ::RestClient::Resource.any_instance.expects(method).raises(*raises)
+      end
+
+    end # Shoulda
+  end # RestClient
+end # EvokeClient
+
+Test::Unit::TestCase.instance_eval { include EvokeClient::RestClient::Shoulda }

data/test/evoke_client_test.rb

@@ -0,0 +1,104 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class EvokeTest < Test::Unit::TestCase
+  def setup
+    @params = {:url => 'foo', :callback_at => Time.now}
+  end
+
+  def teardown
+    Evoke.test = false
+  end
+
+  context "preparing an evokation" do
+    setup do
+      @data = {:foo => 'bar', 'goo' => 'car'}
+      @expected_data = "foo=bar&goo=car"
+      @evoke = Evoke.prepare(@params.merge(:data => @data))
+    end
+    
+    before_should("convert times to UTC") { Time.any_instance.expects(:utc) }
+
+    should "convert data to a single escaped parameter string" do
+      assert_match /foo=bar&?/, @evoke.params[:data]
+      assert_match /goo=car&?/, @evoke.params[:data]
+    end
+  end
+
+  context "saving" do
+    context "a new callback" do
+      setup do
+        expect_restful_request_failure(:get, ::RestClient::ResourceNotFound)
+        expect_restful_request(:post, @params)
+        @evoke = Evoke.prepare(@params)
+      end
+      should("try and post params after not finding a resource") { @evoke.save }
+    end
+
+    context "an existing callback" do
+      setup do
+        expect_restful_request(:get)
+        expect_restful_request(:put, @params)
+        @evoke = Evoke.prepare(@params)
+      end
+      should("try and put params after finding a resource") { @evoke.save }
+    end
+  end
+
+  context "create_or_update!" do
+    should "initialize instance and call save" do
+      fake_evoke = EvokeClient::Base.new
+      EvokeClient::Base.expects(:new).with(@params).returns(fake_evoke)
+      fake_evoke.expects(:save)
+      Evoke.create_or_update!(@params)
+    end
+  end
+
+  context "connection refused" do
+    setup do
+      expect_restful_request_failure(:get, Errno::ECONNREFUSED)
+    end
+
+    should "reraise Evoke::ConnectionRefused when saving" do
+      assert_raise(Evoke::ConnectionRefused) { Evoke.prepare({}).save }
+    end
+    
+    should "reraise Evoke::ConnectionRefused when storing" do
+      assert_raise(Evoke::ConnectionRefused) { Evoke.create_or_update!({}) }
+    end
+  end
+
+  context "host and port:" do
+    context "when unchanged" do
+      setup do
+        Evoke.host = nil
+        Evoke.port = nil
+      end
+      should("return default host") { assert_equal 'evoke.thumblemonks.com', Evoke.host }
+      should("return default port") { assert_nil Evoke.port }
+      should("return default host and port") { assert_equal 'evoke.thumblemonks.com', Evoke.host_and_port }
+    end
+
+    context "when changed" do
+      setup do
+        Evoke.host = 'example.com'
+        Evoke.port = 4567
+      end
+
+      should("return specified host") { assert_equal 'example.com', Evoke.host }
+      should("return specified port") { assert_equal 4567, Evoke.port }
+      should("return specified host and port") { assert_equal 'example.com:4567', Evoke.host_and_port }
+    end
+  end
+
+  context "when test mode is on" do
+    setup do
+      Evoke.test = true
+      @evoke = Evoke.prepare({})
+    end
+
+    should "expect an EvokeClient::Stub class" do
+      assert_kind_of EvokeClient::Stub, @evoke
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'shoulda'
+require 'mocha'
+require 'redgreen'
+
+Shoulda.autoload_macros(File.join(File.dirname(__FILE__), '..'), ['.'])
+
+require 'evoke_client'
+
+Evoke.host = 'localhost'
+Evoke.port = 4567

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: evoke_client
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Justin Knowlden
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-07 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+    version: 
+description: Rest client interface for talking REST to the evoke service
+email: 
+- gus@gusg.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- evoke_client.gemspec
+- lib/evoke_client.rb
+- lib/evoke_client/base.rb
+- lib/evoke_client/stub.rb
+- lib/query_string.rb
+- shoulda_macros/rest_client.rb
+has_rdoc: true
+homepage: http://github.com/thumblemonks/evoke_client
+licenses: []
+
+post_install_message: Choosy wizards choose Thumble Monks.
+rdoc_options: 
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Rest client interface for talking REST to the evoke service
+test_files: 
+- test/evoke_client_test.rb
+- test/test_helper.rb