taskrabbit 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## v0.0.2
+
+* add api_key to config
+* rename client\_secret to api\_secret

data/README.md

@@ -4,9 +4,11 @@ Ruby wrapper for TaskRabbit API.
 
 ## Installation
 
-I have not published the gem yet so you will either have to vendor it or use a Gemfile:
+    gem install taskrabbit
 
-    gem 'taskrabbit', :git => 'git://github.com/jrichardlai/taskrabbit.git'
+Or in a Gemfile:
+
+    gem 'taskrabbit'
 
 
 ## Usage Example
@@ -16,13 +18,17 @@ I have not published the gem yet so you will either have to vendor it or use a G
 In an initializer file.
 
     Taskrabbit.configure do |config|
-      config.client_secret = 'your-client-secret'
+      config.api_secret = 'your-client-secret'
+      config.api_key    = 'your-client-key'
+      config.base_uri   = 'https://sandbox.com'
+      config.endpoint   = 'api/v2'
     end
 
 Available configuration options:
 
-   * client_secret: client secret that has been given to you by TaskRabbit
-   * base_uri: uri of the server (not mandatory, default to www.taskrabbit.com) 
+   * api_secret: client secret that has been given to you by TaskRabbit
+   * api_key: client key that has been given by TaskRabbit
+   * base_uri: uri of the server (not mandatory, default to https://www.taskrabbit.com) 
    * endpoint: endpoint (not mandatory, default to api/v1)
 
 ## Task
@@ -31,7 +37,7 @@ Available configuration options:
 
     tr = Taskrabbit::Api.new
     
-or with a user token
+or with a user token returned by TaskRabbit.
 
     tr = Taskrabbit::Api.new(user_token)
 
@@ -80,7 +86,7 @@ or
 
 ### Error for tasks creation or update
 
-    tr = Taskrabbit::Api.new(client_secret)
+    tr = Taskrabbit::Api.new(user_token)
     task = tr.tasks.new
     unless task.save
       task.error # => "Task title can't be blank, \nAmount you are willing to pay is not a number"
@@ -92,7 +98,7 @@ or
 
 In some case TaskRabbit will return an url which should be used for further operations (i.e: when the user doesn't have a credit card).
 
-    tr = Taskrabbit::Api.new(client_secret)
+    tr = Taskrabbit::Api.new(user_token)
     task = tr.tasks.new
     unless task.save
       if task.redirect?
@@ -102,7 +108,7 @@ In some case TaskRabbit will return an url which should be used for further oper
 
 ## User account
 
-    tr = Taskrabbit::Api.new(client_secret)
+    tr = Taskrabbit::Api.new(user_token)
     tr.account # => Taskrabbit::User object
 
     tr.account.tasks # => List of tasks

data/lib/taskrabbit/api.rb

@@ -35,7 +35,7 @@ module Taskrabbit
         :extra_body => options,
         :extra_request => {
           :headers => {
-            'X-Client-Application' => client_secret.to_s, 
+            'X-Client-Application' => api_secret.to_s, 
             'Authorization' => "OAuth #{user_token.to_s}"
           },
           :endpoint => endpoint.to_s,

data/lib/taskrabbit/config.rb

@@ -1,12 +1,14 @@
 module Taskrabbit
   module Config
-    DEFAULT_BASE_URI      = 'http://www.taskrabbit.com'
-    DEFAULT_END_POINT     = 'api/v1'
-    DEFAULT_CLIENT_SECRET = nil
+    DEFAULT_BASE_URI   = 'http://www.taskrabbit.com'
+    DEFAULT_END_POINT  = 'api/v1'
+    DEFAULT_API_SECRET = nil
+    DEFAULT_API_KEY    = nil
 
     VALID_OPTIONS_KEYS = [
       :base_uri,
-      :client_secret,
+      :api_key,
+      :api_secret,
       :endpoint
     ]
 
@@ -33,9 +35,10 @@ module Taskrabbit
     # Reset all configuration options to defaults
     def reset
       self.tap do |c|
-        c.base_uri      = DEFAULT_BASE_URI
-        c.endpoint      = DEFAULT_END_POINT
-        c.client_secret = DEFAULT_CLIENT_SECRET
+        c.base_uri   = DEFAULT_BASE_URI
+        c.endpoint   = DEFAULT_END_POINT
+        c.api_secret = DEFAULT_API_SECRET
+        c.api_key    = DEFAULT_API_KEY
       end
     end
     

data/lib/taskrabbit/version.rb

@@ -1,3 +1,3 @@
 module Taskrabbit
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/spec_helper.rb

@@ -17,9 +17,9 @@ TR_USERS = {
 module Taskrabbit
   module Config
     remove_const(:DEFAULT_BASE_URI)
-    remove_const(:DEFAULT_CLIENT_SECRET)
-    DEFAULT_BASE_URI      = 'http://localhost:3000'
-    DEFAULT_CLIENT_SECRET = 'euqmQpzV04GmN1dJTY639PdI7eiSjCjI3lKTkPWn'
+    remove_const(:DEFAULT_API_SECRET)
+    DEFAULT_BASE_URI   = 'http://localhost:3000'
+    DEFAULT_API_SECRET = 'euqmQpzV04GmN1dJTY639PdI7eiSjCjI3lKTkPWn'
   end
 end
 Taskrabbit.reset

data/spec/taskrabbit/api_spec.rb

@@ -16,13 +16,13 @@ describe Taskrabbit::Api do
   end
 
   it "should return an error if the client is not set" do
-    secret = Taskrabbit.client_secret
-    Taskrabbit.client_secret = nil
+    secret = Taskrabbit.api_secret
+    Taskrabbit.api_secret = nil
     tr = Taskrabbit::Api.new
     VCR.use_cassette('tasks/without_client', :record => :new_episodes) do
       expect { tr.tasks.all }.to raise_error(Taskrabbit::Error, 'Missing valid client application')
     end
-    Taskrabbit.client_secret = secret
+    Taskrabbit.api_secret = secret
   end
 
   it "should return an error if the client is not set" do

data/spec/taskrabbit/taskrabbit_spec.rb

@@ -23,9 +23,9 @@ describe Taskrabbit do
   end
   
   describe "api defaults" do
-    it "should be able to set the client_secret" do
-      Taskrabbit.client_secret = 'asecret'
-      Taskrabbit.client_secret.should == 'asecret'
+    it "should be able to set the api_secret" do
+      Taskrabbit.api_secret = 'asecret'
+      Taskrabbit.api_secret.should == 'asecret'
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: taskrabbit
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Jean-Richard Lai
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-19 00:00:00 -07:00
+date: 2012-06-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,6 +62,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - .rspec
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - README.md