shushu 0.1.9 → 0.1.10

data/lib/helpers/http_helpers.rb

@@ -9,7 +9,10 @@ module Shushu
     end
 
     def headers
-      {:content_type => :json, :accept => :json}
+      {
+        :content_type => :json,
+        :accept       => :json
+      }
     end
 
     def enc_json(hash)
@@ -26,19 +29,8 @@ module Shushu
         dec_json(resp.body)
       rescue RestClient::Exception => e
         body = dec_json(e.http_body)
-        case e.http_code
-        when 404
-        when 401
-          raise(AuthorizationError, "Response: #{body.inspect}")
-        when 403
-        when 409
-        when 500
-          raise(UnexpectedError, "Response: #{body.inspect}")
-        when 503
-          raise(ServiceDownError, "#{Shushu.url} is down for maintenance.")
-        else
-          raise(UnexpectedError, "Response: #{body.inspect}")
-        end
+        code = e.http_code
+        raise(ShushuException, "Error in HTTP request. code=#{code} body=#{body}")
       end
     end
 

data/lib/models/p_method.rb

@@ -0,0 +1,20 @@
+module Shushu
+  module PMethod
+    extend self
+
+    def create(args)
+      Shushu.handle_req {RestClient.post(p_method_url, args, Shushu.headers)}
+    end
+
+    def update(args)
+      id = args.delete(:id)
+      Shushu.handle_req {RestClient.put(p_method_url(id), args, Shushu.headers)}
+    end
+
+    def p_method_url(id=nil)
+      url = [Shushu.url, "/payment_methods"].join
+      id.nil? ? url : url << "/#{id}"
+    end
+
+  end
+end

data/lib/models/res_own.rb

@@ -17,7 +17,7 @@ module Shushu
       eid = args.delete(:entity_id)
       hid = args[:hid]
       time = args[:time]
-      Shushu.handle_req {RestClient.delete([res_own_url(aid, eid), build_q_params(:hid => hid, :time => time)].join)}
+      Shushu.handle_req {RestClient.delete([res_own_url(aid, eid), Shushu::HttpHelpers.build_q_params(:hid => hid, :time => time)].join)}
     end
 
     def query(args)

data/lib/shushu.rb

@@ -13,12 +13,7 @@ module Shushu
   extend self
   extend HttpHelpers
 
-  ShushuException     = Class.new(Exception)
-  AuthenticationError = Class.new(ShushuException)
-  AuthorizationError  = Class.new(ShushuException)
-  ServiceDownError    = Class.new(ShushuException)
-  UnexpectedError     = Class.new(ShushuException)
-  SymanticError       = Class.new(ShushuException)
+  ShushuException = Class.new(Exception)
 
   def url
     Client.url
@@ -58,6 +53,7 @@ require "models/res_own"
 require "models/r_code"
 require "models/rev_rep"
 require "models/heart_beat"
+require "models/p_method"
 
 require "services/line_item_builder"
 

data/readme.md

@@ -1,6 +1,6 @@
 # Shushu Client
 
-This gem wraps the APIs defined [here](https://github.com/heroku/shushud/tree/master/doc).
+This gem wraps the [Shushu API](https://github.com/heroku/shushud/tree/master/doc).
 The shushu client also provides a set of objects that help with the presentation
 of an invoice.
 
@@ -8,91 +8,115 @@ of an invoice.
 
 ```bash
 $ gem install shushu
+$ export SHUSHU_URL=https://123:secret@shushu.heroku.com
 ```
 
-```bash
-# Optional. When set, shushu will ignore bad responses from Shushu's API.
-# Default: false
+## Usage
 
-$SHUSHU_CLIENT_UNSAFE=true
-```
+There are two ways to interact with Shushu APIs using this client. The first
+approach will rely on the credentials in `SHUSHU_URL`.
 
-```bash
-# Required
-# Default: nil
-
-$SHUSHU_URL=https://shushu-stg.heroku.com
+```ruby
+Shushu::BEvent.open({})
 ```
 
-**Ruby configuration will take precedence over environment variables.**
+The second approach allows for credentials other than the ones stored in the
+`SHUSHU_URL`.
 
 ```ruby
-Shushu.url = "https://core:secret@shushu-stg.heroku.com"
+shushu = Shushu::Client.new("https://other_provider_id:other_provider_token@shushu.heroku.com")
+shushu[:b_event].open({})
 ```
 
-## Usage
+### PaymentMethod
+
+This API deals primarily with credit cards. PaymentMethods can be created
+indipendintly of Accounts. You will need a payment_method to generate an
+invoice.
 
-You can call methods in models directly via the model's module or you can create
-a client object to dispatch methods to the model. This is useful if want to use
-provider credentials other than the ones defined in the `$SHUSHU_URL`
+Reference: [PaymentMethod API](https://github.com/heroku/shushud/blob/master/doc/payment_methods_api.md)
+
+Create a new payment method with encrypted values:
 
 ```ruby
-shushu = Shushu::Client.new("https://other_provider_id:other_provider_token@shushu.heroku.com")
-shushu[:b_event].open({})
+PMethod.create(
+  :card_num => "some encrypted value",
+  :card_exp_year => "2012",
+  :card_exp_month => "12"
+)
+#=> {:id => "12345", :card_token => "abc123", :card_type => "visa", :card_last4 => "1111"}
 ```
-Is equivalent to:
+
+Update a payment_method with a new credit card:
 
 ```ruby
-Shushu::BEvent.open({})
+PMethod.update(
+  :id => "001",
+  :card_num => "some encrypted value",
+  :card_exp_year => "2012",
+  :card_exp_month => "12"
+)
+#=> {:id => "001", :card_token => "abc123", :card_type => "visa", :card_last4 => "1111"}
 ```
 
-### PaymentMethods
+Create a new payment_method with a token. Note, this endpoint is idempotent with
+respect to the id and token.
 
-This API deals primarily with credit cards. PaymentMethods can be created
-indipendintly of Accounts. You will need a payment_method to generate an
-invoice.
+```ruby
+PMethod.update(:id => "my-custom-id", :card_token => "abc123")
+#=> {:id => "my-custom-id", :card_token => "abc123"}
+```
+```
+
+To mark a payment_method in such a way that credit card processing will be
+disabled:
 
 ```ruby
-  #TODO Build API
+PMethod.update(:id => "001", :non_receivable => true)
+#=> {:id => "001", :non_receivable => true}
 ```
 
-### Accounts
+### Account
 
 This API deals with accounts which is a primitive for grouping resources. You
 will need an account to generate a usage report.
 
 ```ruby
-  Shushu::Account.create
-  #=> {:id => "001"}
+Shushu::Account.create
+#=> {:id => "001"}
 ```
 
-### AccountOwnerships
+### AccountOwnership
 
-Use this API when you want to setup associations between Vault accounts and
-Vault payment_methods.
+Use this API when you want to setup associations between Shushu accounts and
+Shushu payment_methods.
 
 Reference: [AccountOwnerships API](https://github.com/heroku/shushud/blob/master/doc/account_ownership_api.md)
 
+To associate an account with a payment_method:
+
 ```ruby
-  # To associate an account with a payment_method
-  Shushu::AcctOwn.act(
-    :account_id        => vault_account_id,
-    :payment_method_id => payment_method_id,
-    :entity_id         => entity_id,
-    :time              => time
-  )
-  #=> {"payment_method_id"=>"123", "account_id"=>"1", "entity_id"=>"entity123"}
-
-  # Now we need to change the payment_method on an account
-  Shushu::AcctOwn.xfr(
-    :prev_payment_method_id => prev_payment_method_id,
-    :payment_method_id      => new_payment_method_id,
-    :account_id             => account_id,
-    :prev_entity_id         => prev_entity_id,
-    :entity_id              => entity_id,
-    :time                   => time
-  )
-  #=> {"payment_method_id"=>"456", "account_id"=>"1", "entity_id"=>"event124"}
+Shushu::AcctOwn.act(
+  :account_id        => vault_account_id,
+  :payment_method_id => payment_method_id,
+  :entity_id         => entity_id,
+  :time              => time
+)
+#=> {"payment_method_id"=>"123", "account_id"=>"1", "entity_id"=>"entity123"}
+```
+
+Now we need to change the payment_method on an account:
+
+```ruby
+Shushu::AcctOwn.xfr(
+  :prev_payment_method_id => prev_payment_method_id,
+  :payment_method_id      => new_payment_method_id,
+  :account_id             => account_id,
+  :prev_entity_id         => prev_entity_id,
+  :entity_id              => entity_id,
+  :time                   => time
+)
+#=> {"payment_method_id"=>"456", "account_id"=>"1", "entity_id"=>"event124"}
 ```
 
 ### RateCode
@@ -107,12 +131,12 @@ RateCode.
 Reference: [RateCode API](https://github.com/heroku/shushud/blob/master/doc/rate_code_api.md)
 
 ```ruby
-  Shushu::RCode.create(
-    :rate => 5,
-    :product_group => "addon",
-    :product_name => "postgres"
-  )
-  #=> {:slug => "AO01", :rate => 5, :product_group => "addon", :product_name => "postgres"}
+Shushu::RCode.create(
+  :rate => 5,
+  :product_group => "addon",
+  :product_name => "postgres"
+)
+#=> {:slug => "AO01", :rate => 5, :product_group => "addon", :product_name => "postgres"}
 ```
 
 ### ResourceOwnership
@@ -122,36 +146,42 @@ Heroku apps and Teams.
 
 Reference: [ResourceOwnership API](https://github.com/heroku/shushud/blob/master/doc/resource_ownership_api.md)
 
+When a new app is created, activate a new resource_ownership record.
+
 ```ruby
-  # When a new app is created, activate a new resource_ownership record.
-  Shushu::ResOwn.act(
-    :hid              => hid,
-    :entity_id        => entity_id,
-    :account_id       => vault_account_id,
-    :time             => time
-  )
-  #=> {"hid"=>"123", "account_id"=>"1", "entity_id"=>"event123"}
+Shushu::ResOwn.act(
+  :hid              => hid,
+  :entity_id        => entity_id,
+  :account_id       => vault_account_id,
+  :time             => time
+)
+#=> {"hid"=>"123", "account_id"=>"1", "entity_id"=>"event123"}
+```
 
+When an app is transfered to another vault account, transfer the resource_ownership record.
 
-  # When an app is transfered to another vault account, transfer the resource_ownership record.
-  Shushu::ResOwn.xfr(
-    :hid                   => hid,
-    :prev_entity_id        => prev_entity_id,
-    :prev_vault_account_id => prev_vault_account_id,
-    :entity_id             => entity_id,
-    :account_id            => new_vault_account_id,
-    :time                  => time
-  )
-  #=> {"hid"=>"123", "account_id"=>"1", "entity_id"=>"event123"}
-
-  # When an app is destroyed, deactivate the resource_ownership record.
-  Shushu::ResOwn.deact(
-    :hid        => hid,
-    :entity_id  => entity_id,
-    :account_id => vault_account_id,
-    :time       => time
-  )
-  #=> {"hid"=>"123", "account_id"=>"1", "entity_id"=>"event123"}
+```ruby
+Shushu::ResOwn.xfr(
+  :hid                   => hid,
+  :prev_entity_id        => prev_entity_id,
+  :prev_vault_account_id => prev_vault_account_id,
+  :entity_id             => entity_id,
+  :account_id            => new_vault_account_id,
+  :time                  => time
+)
+#=> {"hid"=>"123", "account_id"=>"1", "entity_id"=>"event123"}
+```
+
+When an app is destroyed, deactivate the resource_ownership record.
+
+```ruby
+Shushu::ResOwn.deact(
+  :hid        => hid,
+  :entity_id  => entity_id,
+  :account_id => vault_account_id,
+  :time       => time
+)
+#=> {"hid"=>"123", "account_id"=>"1", "entity_id"=>"event123"}
 ```
 
 ### BillableEvent
@@ -161,42 +191,42 @@ emitting events prior to setting up relationships between accounts and
 payment_methods. (Although, usage reports and invoices will not be available
 until account_ownerships and resource_ownerships have been established.)
 
-For complete details on the semantics of this API, read the [BillableEvents
-API docs.](https://github.com/heroku/shushu/blob/master/doc/events_api.md)
-
 Reference: [BillableEvent API](https://github.com/heroku/shushud/blob/master/doc/billable_events_api.md)
 
+Open an event when you would like to start billing.
+
 ```ruby
-  # Open an event when you would like to start billing.
-  Shushu::BEvent.open(
-    :entity_id    => entity_id,
-    :hid          => hid,
-    :time         => time,
-    :rate_code    => rate_code,
-    :product_name => product_name,
-    :qty          => qty
-  )
+Shushu::BEvent.open(
+  :entity_id    => entity_id,
+  :hid          => hid,
+  :time         => time,
+  :rate_code    => rate_code,
+  :product_name => product_name,
+  :qty          => qty
+)
+```
+
+Don't forget to close it.
 
-  # Don't forget to close it.
+```ruby
   Shushu::BEvent.close(
     :entity_id => entity_id,
     :time      => time
   )
 ```
 
-### UsageReports
+### UsageReport
 
 ```ruby
-  report = Shushu::UsageReport.new(account_id, from, to)
-  report.billable_units
+report = Shushu::UsageReport.new(account_id, from, to)
+report.billable_units
 ```
 
-
-### Invoices
+### Invoice
 
 ```ruby
-  invoice = Shushu::UsageReport.new(account_id, from, to)
-  invoice.billable_units
+invoice = Shushu::UsageReport.new(account_id, from, to)
+invoice.billable_units
 ```
 
 
@@ -237,7 +267,7 @@ You can customize the LineItemBuilder by creating a new class that responds to
 build and passing it to the ReportPresenter.
 
 ```ruby
-  ReportPresenter.new(report, CustomLineItemBuilder)
+ReportPresenter.new(report, CustomLineItemBuilder)
 ```
 
 #### LineItemPresenter
@@ -248,12 +278,10 @@ LineItemBuilder partitioned unit_groups based upon product_group, you can ask
 the LineItemPresenter for infomation about subsets of unit_groups. For instance:
 
 ```ruby
-  line_item_presenter.unit_group_presenters("dyno")
-  line_item_presenter.unit_group_total("dyno")
-  line_item_presenter.unit_group_qty("dyno")
+line_item_presenter.unit_group_presenters("dyno")
+line_item_presenter.unit_group_total("dyno")
+line_item_presenter.unit_group_qty("dyno")
 ```
-
-
 #### UnitGroupPresenter
 
 UnitGroups are collections of billable_units that are partitioned by

data/test/models/p_method_test.rb

@@ -0,0 +1,29 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+class PMethodTest < ShushuTest
+
+  def test_create
+    params = {
+      :card_token => "abc123"
+    }
+    api_resp_body = Shushu::HttpHelpers.enc_json(params)
+    Shushu.url = "http://provider:password@shushu.heroku.com"
+    FakeWeb.register_uri(:post, (Shushu.url + "/payment_methods"), :body => api_resp_body)
+    response = Shushu::PMethod.create(params)
+    assert_equal("abc123", response["card_token"])
+  end
+
+  def test_update
+    params = {
+      :id => "1",
+      :card_token => "abc123"
+    }
+    api_resp_body = Shushu::HttpHelpers.enc_json(params)
+    Shushu.url = "http://provider:password@shushu.heroku.com"
+    FakeWeb.register_uri(:put, (Shushu.url + "/payment_methods/1"), :body => api_resp_body)
+    response = Shushu::PMethod.update(params)
+    assert_equal("abc123", response["card_token"])
+    assert_equal("1", response["id"])
+  end
+
+end

data/test/models/rev_rep_test.rb

@@ -4,7 +4,7 @@ class RevRepTest < ShushuTest
   def test_for_month
     api_resp_body = Shushu::HttpHelpers.enc_json({:ok => true})
     Shushu.url = "http://provider:password@shushu.heroku.com"
-    url = Shushu.url + "/rev_rep?from%3D2011-01-01+00%3A00%3A00+UTC&to%3D2011-02-01+00%3A00%3A00+UTC"
+    url = Shushu.url + "/rev_report?from=2011-01-01+00%3A00%3A00+UTC&to=2011-02-01+00%3A00%3A00+UTC"
     FakeWeb.register_uri(:get, url, :body => api_resp_body)
     Shushu::RevRep.get(Time.utc(2011,1), Time.utc(2011,2))
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shushu
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-12-29 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &8914300 !ruby/object:Gem::Requirement
+  requirement: &7563340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *8914300
+  version_requirements: *7563340
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &8913620 !ruby/object:Gem::Requirement
+  requirement: &7555000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *8913620
+  version_requirements: *7555000
 description: A ruby wrapper around Shushu's HTTP API.
 email: ryan@heroku.com
 executables: []
@@ -50,6 +50,7 @@ files:
 - lib/models/acct_own.rb
 - lib/models/report.rb
 - lib/models/unit_group.rb
+- lib/models/p_method.rb
 - lib/models/rev_rep.rb
 - lib/models/line_item.rb
 - lib/models/heart_beat.rb
@@ -66,6 +67,7 @@ files:
 - test/models/billable_unit_test.rb
 - test/models/b_event_test.rb
 - test/models/unit_group_test.rb
+- test/models/p_method_test.rb
 - test/models/rev_rep_test.rb
 - test/models/line_item_test.rb
 - test/services/line_item_builder_test.rb
@@ -101,6 +103,7 @@ test_files:
 - test/models/billable_unit_test.rb
 - test/models/b_event_test.rb
 - test/models/unit_group_test.rb
+- test/models/p_method_test.rb
 - test/models/rev_rep_test.rb
 - test/models/line_item_test.rb
 - test/services/line_item_builder_test.rb