evoke_client 0.2.1 → 0.2.2

data/README.markdown

@@ -1,35 +1,95 @@
 # 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.
+The Evoke client is a simple HTTParty utility for allowing your application to converse with an [Evoke service](http://github.com/thumblemonks/evoke).
+
+Soon, there will be a global Evoke app that your app can talk to. For now, you should run your own server.
 
 ### Usage
 
-    # evoke = Evoke.new(:url => 'http://example.com/users/unsubscribe', :callback_at => (Time.now + 86400))
-    # evoke.save
+Essentially, the Evoke client acts like an `ActiveRecord` model. The basic methods are:
+
+* Evoke::Callback.find(guid)
+* Evoke::Callback.create\_or\_update(attributes\_hash)
+* Evoke::Callback#update\_attributes(hash\_to\_merge)
+* Evoke::Callback#save
+* Evoke::Callback#destroy
+
+Typically, you would simply need to call `create_or_update` from wherever you are calling out to Evoke. Most of the apps we use Evoke client with make calls similar to the following:
+
+    class SomeObject
+      def some_method
+        ...
+        Evoke::Callback.create_or_update(
+          "guid" => "some-kind-of-unique-string",
+          "url" => "http://example.com/users/unsubscribe",
+          "callback_at" => Time.now + 3600)
+        ...
+      end
+    end
+
+The Evoke client will raise an `Evoke::RecordInvalid` exception if the callback could not be created or updated for some reason. This is the same for an explicit call to save. The reason for the failure will be returned in the exception as the message.
+
+If you wanted to explicitly do what `create_or_update` is doing for you in your code, you would likely write your code like so:
 
-    Evoke.configure(...)
-    callback = Evoke::Callback.new(:url => 'http://example.com/users/unsubscribe', :callback_at => (Time.now + 86400))
+    ...
+    callback = Evoke::Callback.find("some-kind-of-unique-string")
+    if callback
+      callback.update_attributes("callback_at" => Time.now + 3600)
+    else
+      callback = Evoke::Callback.new(
+        "guid" => "some-kind-of-unique-string",
+        "url" => "http://example.com/users/unsubscribe",
+        "callback_at" => Time.now + 3600)
+    end
     callback.save
-    
-    callback = Evoke::Callback.find(guid)
+    ...
+
+If you no longer need a callback, you can destroy it. Simply find the callback and then call its destroy method.
+
+    callback = Evoke::Callback.find("some-kind-of-unique-string")
     callback.destroy
-    callback.update
-    
-    # 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 somewhere after you have required in (see following sections) the Evoke client:
+
+    Evoke.configure "http://example.com:4567"
+
+If you're using a newer version Rails, you could set it in an initializer. However, you may not want to be adding callbacks to your production instance of Evoke when doing local development. It's probably better to explicitly configure Evoke in your `development.rb` and `production.rb` files.
+
+Then, if you're using Rails, put this is your `development.rb` and `production.rb` files:
+
+    config.gem 'evoke_client', :src => "http://gemcutter.org"
 
-To modify host and port, just set the following:
+Otherwise, do the standard:
 
-    Evoke.host = "example.com"
-    Evoke.port = "4567"
-    # Choosing 4567 because Evoke is written for Sinatra
+    require 'evoke_client'
+
+#### Testing
+
+If using Rails, put this is your `config/environment/test.rb`:
+
+    config.gem 'evoke_client', :lib => 'evoke_client/mock', :src => "http://gemcutter.org"
+
+If not using Rails, put this in your `test_helper.rb` or whatever you call it:
+
+    require 'evoke_client/mock'
+
+You need to make sure you have required in `evoke_client/mock` **AFTER** you have required `evoke_client`. Otherwise ... bad stuff.
+
+Don't worry about calling `Evoke.configure` if you're requiring in the mock library. It's irrelevant. What is relevant, however, is mocking out the calls Evoke client will send to HTTParty. Evoke client has a solution, but I need to document it here and I'm not ready yet. Sorry.
+
+    DOCUMENTATION NEEDED FOR HTTMockParty
 
 ### Installation
 
-    gem install thumblemonks-evoke_client
+If you haven't done so yet, you should add the GemCutter source to your list of gem sources:
+
+    gem sources -a http://gemcutter.org
+
+Then installing the Evoke client is as simple as:
+
+    gem install evoke_client
 
 #### Dependencies
 

data/evoke_client.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name     = "evoke_client"
-  s.version  = "0.2.1"
+  s.version  = "0.2.2"
   s.date     = "2009-10-07"
   s.summary  = "Tool for interfacing with the Evoke web service"
   s.email    = %w[gus@gusg.us]
@@ -14,6 +14,7 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ["README.markdown"]
 
   s.add_dependency("httparty", [">= 0.4.4"])
+  s.add_development_dependency("riot", [">= 0.9.6"])
 
   s.files = %w[
     MIT-LICENSE
@@ -21,11 +22,13 @@ Gem::Specification.new do |s|
     evoke_client.gemspec
     lib/evoke_client.rb
     lib/evoke_client/base.rb
+    lib/evoke_client/mash.rb
     lib/evoke_client/mock.rb
   ]
 
   s.test_files = %w[
     Rakefile
+    test/callback_test.rb
     test/configuration_test.rb
     test/create_or_update_test.rb
     test/create_test.rb

data/lib/evoke_client/base.rb

@@ -1,3 +1,5 @@
+require 'evoke_client/mash'
+
 module Evoke
   class RecordError < Exception; end
   class RecordInvalid < RecordError; end
@@ -14,6 +16,7 @@ module Evoke
     end
 
     def self.create_or_update(data)
+      data = Callback.stringify_keys(data)
       callback = (find(data["guid"]) || new(data)).update_attributes(data)
       callback.save
       callback
@@ -21,13 +24,13 @@ module Evoke
 
     def initialize(data)
       @new_record = determine_if_new_record(data.delete(:new_record))
-      @data = data
+      @data = Callback.stringify_keys(data)
     end
 
     def new_record?; @new_record; end
 
     def update_attributes(new_data)
-      @data = @data.merge(new_data)
+      @data = @data.merge(Callback.stringify_keys(new_data))
       self
     end
 
@@ -56,5 +59,9 @@ module Evoke
     def determine_if_new_record(condition)
       condition.nil? || condition
     end
+    
+    def self.stringify_keys(hash)
+      hash.mash { |k,v| {k.to_s => v} }
+    end
   end # Callback
 end # Evoke

data/lib/evoke_client/mash.rb

@@ -0,0 +1,9 @@
+module Enumerable
+  # Let's you do stuff like:
+  #
+  #   hashed_users = [:id, :name].mash {|attr| {attr => attr.to_s} }
+  #   => {:id => 'id', :name => 'name'}
+  def mash
+    self.inject({}) { |a,i| a.merge( yield(i) ) }
+  end
+end

data/test/callback_test.rb

@@ -0,0 +1,22 @@
+require 'teststrap'
+
+context "initializing a new callback" do
+  setup do
+    Evoke::Callback.new("url" => "foo", :guid => "papa")
+  end
+
+  asserts("url is accessible from a string key") { topic.url }.equals("foo")
+  asserts("guid is accessible from a symbolized key") { topic.guid }.equals("papa")
+end
+
+context "updating attributes of a callback" do
+  setup do
+    callback = Evoke::Callback.new("guid" => "meme", "url" => "http://foo.bar", "http_method" => "get")
+    callback.update_attributes("guid" => "mom", :url => "http://a.b")
+    callback
+  end
+
+  asserts("guid updated from a string key") { topic.guid }.equals("mom")
+  asserts("url updated form a symbolized key") { topic.url }.equals("http://a.b")
+  asserts("http_method is unchanged") { topic.http_method }.equals("get")
+end # updating attributes of a callback

data/test/create_or_update_test.rb

@@ -7,7 +7,7 @@ context "create or update" do
       Evoke::HTTMockParty.get('/callbacks/poster').not_found
       Evoke::HTTMockParty.post('/callbacks', :query => {"guid" => "poster"}).
         responds({"url" => "http://poster"}).created
-      Evoke::Callback.create_or_update({"guid" => "poster"})
+      Evoke::Callback.create_or_update({:guid => "poster"})
     end
 
     should "post to callbacks and update itself accordingly" do

data/test/update_test.rb

@@ -1,17 +1,5 @@
 require 'teststrap'
 
-context "updating attributes of a callback" do
-  setup do
-    callback = Evoke::Callback.new("guid" => "meme", "url" => "http://foo.bar", "http_method" => "get")
-    callback.update_attributes("guid" => "mom", "url" => "http://a.b")
-    callback
-  end
-
-  asserts("guid updated") { topic.guid }.equals("mom")
-  asserts("url updated") { topic.url }.equals("http://a.b")
-  asserts("http_method is unchanged") { topic.http_method }.equals("get")
-end # updating attributes of a callback
-
 context "updating a callback" do
 
   context "that actually exists" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: evoke_client
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Justin Knowlden
@@ -22,6 +22,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.4.4
     version: 
+- !ruby/object:Gem::Dependency 
+  name: riot
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.6
+    version: 
 description: Tool for interfacing with the Evoke web service. See http://github.com/thumblemonks/evoke
 email: 
 - gus@gusg.us
@@ -37,6 +47,7 @@ files:
 - evoke_client.gemspec
 - lib/evoke_client.rb
 - lib/evoke_client/base.rb
+- lib/evoke_client/mash.rb
 - lib/evoke_client/mock.rb
 has_rdoc: true
 homepage: http://github.com/thumblemonks/evoke_client
@@ -69,6 +80,7 @@ specification_version: 3
 summary: Tool for interfacing with the Evoke web service
 test_files: 
 - Rakefile
+- test/callback_test.rb
 - test/configuration_test.rb
 - test/create_or_update_test.rb
 - test/create_test.rb