jsmestad-chargify 0.3.0.pre5

data/lib/chargify/customer.rb

@@ -0,0 +1,72 @@
+module Chargify
+  class Customer < Base
+
+    class << self
+
+      # options: page
+      def all(options={})
+        customers = api_request(:get, '/customers.json', :query => options)
+        customers.map{|c| Hashie::Mash.new c['customer']}
+      end
+
+      def find(id)
+        return all if id == :all
+
+        request = api_request(:get, "/customers/#{id}.json")
+        success = request.code == 200
+        response = Hashie::Mash.new(request).customer if success
+        Hashie::Mash.new(response || {}).update(:success? => success)
+      end
+
+      # def find!(id)
+        # request = api_request(:get, "/customers/#{id}.json", :raise_errors => true)
+        # response = Hashie::Mash.new(request).customer
+      # end
+
+      def lookup(reference_id)
+        request = api_request(:get, "/customers/lookup.json?reference=#{reference_id}")
+        success = request.code == 200
+        response = Hashie::Mash.new(request).customer if success
+        Hashie::Mash.new(response || {}).update(:success? => success)
+      end
+
+      #
+      # * first_name (Required)
+      # * last_name (Required)
+      # * email (Required)
+      # * organization (Optional) Company/Organization name
+      # * reference (Optional, but encouraged) The unique identifier used within your own application for this customer
+      #
+      def create(info={})
+        result = api_request(:post, "/customers.json", :body => {:customer => info})
+        created = true if result.code == 201
+        response = Hashie::Mash.new(result)
+        (response.customer || response).update(:success? => created)
+      end
+
+      #
+      # * first_name (Required)
+      # * last_name (Required)
+      # * email (Required)
+      # * organization (Optional) Company/Organization name
+      # * reference (Optional, but encouraged) The unique identifier used within your own application for this customer
+      #
+      def update(info={})
+        info.stringify_keys!
+        chargify_id = info.delete('id')
+        result = api_request(:put, "/customers/#{chargify_id}.json", :body => {:customer => info})
+
+        response = Hashie::Mash.new(result)
+        return response.customer unless response.customer.to_a.empty?
+        response
+      end
+
+      def subscriptions(id)
+        subscriptions = api_request(:get, "/customers/#{id}/subscriptions.json")
+        subscriptions.map{|s| Hashie::Mash.new s['subscription']}
+      end
+
+    end
+
+  end
+end

data/lib/chargify/error.rb

@@ -0,0 +1,23 @@
+module Chargify
+  module Error
+
+    class Base < StandardError
+      attr_reader :response
+
+      def initialize(response=nil)
+        @response  = response
+      end
+    end
+
+    class AccessDenied        < Base; end # 401 errors
+    class Forbidden           < Base; end # 403 errors
+    class BadRequest          < Base; end # 422 errors
+    class NotFound            < Base; end # 404 errors
+    class GatewayTimeout      < Base; end # 504 errors
+    class ConnectionFailed    < Base; end
+    
+    class UnexpectedResponse  < Base; end
+
+  end
+end
+

data/lib/chargify/parser.rb

@@ -0,0 +1,13 @@
+module Chargify
+  class Parser < HTTParty::Parser
+
+    def parse
+      begin
+        Crack::JSON.parse(body)
+      rescue => e
+        raise(Chargify::Error::UnexpectedResponse.new(e.message), body)
+      end
+    end
+
+  end
+end

data/lib/chargify/product.rb

@@ -0,0 +1,26 @@
+module Chargify
+  class Product < Base
+
+    class << self
+
+      def all
+        result = api_request(:get, "/products.json")
+        result.map{|p| Hashie::Mash.new p['product']}
+      end
+
+      def find(id)
+        return all if id == :all
+
+        result = api_request(:get, "/products/#{id}.json")
+        Hashie::Mash.new(result).product
+      end
+
+      def find_by_handle(handle)
+        result = api_request(:get, "/products/handle/#{handle}.json")
+        Hashie::Mash.new(result).product
+      end
+
+    end
+
+  end
+end

data/lib/chargify/subscription.rb

@@ -0,0 +1,93 @@
+module Chargify
+  class Subscription < Base
+
+    class << self
+
+      def find(id)
+        result = api_request(:get, "/subscriptions/#{id}.json")
+        return nil if result.code != 200
+        Hashie::Mash.new(result).subscription
+      end
+
+      # Returns all elements outputted by Chargify plus:
+      # response.success? -> true if response code is 201, false otherwise
+      def create(subscription_attributes={})
+        result = api_request(:post, "/subscriptions.json", :body => {:subscription => subscription_attributes})
+        created  = true if result.code == 201
+        response = Hashie::Mash.new(result)
+        (response.subscription || response).update(:success? => created)
+      end
+
+      # Returns all elements outputted by Chargify plus:
+      # response.success? -> true if response code is 200, false otherwise
+      def update(sub_id, subscription_attributes = {})
+        result = api_request(:put, "/subscriptions/#{sub_id}.json", :body => {:subscription => subscription_attributes})
+        updated = true if result.code == 200
+        response = Hashie::Mash.new(result)
+        (response.subscription || response).update(:success? => updated)
+      end
+
+      # Returns all elements outputted by Chargify plus:
+      # response.success? -> true if response code is 200, false otherwise
+      def cancel(sub_id, message="")
+        result = api_request(:delete, "/subscriptions/#{sub_id}.json", :body => {:subscription => {:cancellation_message => message} })
+        deleted = true if result.code == 200
+        response = Hashie::Mash.new(result)
+        (response.subscription || response).update(:success? => deleted)
+      end
+
+      def reactivate(sub_id)
+        result = api_request(:put, "/subscriptions/#{sub_id}/reactivate.json", :body => "")
+        reactivated  = true if result.code == 200
+        response = Hashie::Mash.new(result) rescue Hashie::Mash.new
+        (response.subscription || response).update(:success? => reactivated)
+      end
+
+      def charge(sub_id, subscription_attributes={})
+        result = api_request(:post, "/subscriptions/#{sub_id}/charges.json", :body => { :charge => subscription_attributes })
+        success = result.code == 201
+        result = {} if result.code == 404
+
+        response = Hashie::Mash.new(result)
+        (response.charge || response).update(:success? => success)
+      end
+
+      def migrate(sub_id, product_id)
+        result = api_request(:post, "/subscriptions/#{sub_id}/migrations.json", :body => {:product_id => product_id })
+        success = true if result.code == 200
+        response = Hashie::Mash.new(result)
+        (response.subscription || {}).update(:success? => success)
+      end
+
+      def transactions(sub_id, options={})
+        result = api_request(:get, "/subscriptions/#{sub_id}/transactions.json", :query => options)
+        result.map{|t| Hashie::Mash.new t['transaction']}
+      end
+
+      def components(subscription_id)
+        result = api_request(:get, "/subscriptions/#{subscription_id}/components.json")
+        result.map{|c| Hashie::Mash.new c['component']}
+      end
+
+      def find_component(subscription_id, component_id)
+        result = get("/subscriptions/#{subscription_id}/components/#{component_id}.json")
+        Hashie::Mash.new(result).component
+      end
+
+      def update_component(subscription_id, component_id, quantity)
+        result = api_request(:put, "/subscriptions/#{subscription_id}/components/#{component_id}.json", :body => {:component => {:allocated_quantity => quantity}})
+        result[:success?] = result.code == 200
+        Hashie::Mash.new(result)
+      end
+
+      def component_usage(subscription_id, component_id)
+        result = api_request(:get, "/subscriptions/#{subscription_id}/components/#{component_id}/usages.json")
+        success = result.code == 200
+        response = Hashie::Mash.new(result)
+        response.update(:success? => success)
+      end
+
+    end
+
+  end
+end

data/lib/chargify/transaction.rb

@@ -0,0 +1,14 @@
+module Chargify
+  class Transaction < Base
+
+    class << self
+
+      def all(options={})
+        result = api_request(:get, "/transactions.json", :query => options)
+        result.map{|t| Hashie::Mash.new t['transaction']}
+      end
+
+    end
+
+  end
+end

data/spec/fixtures/charge_subscription.json

@@ -0,0 +1,5 @@
+{"charge":{
+  "success":true,
+  "memo":"This is the description of the one time charge.",
+  "amount_in_cents":100
+}}

data/spec/fixtures/charge_subscription_missing_parameters.json

@@ -0,0 +1,4 @@
+{"errors":[
+  "Memo: cannot be blank.",
+  "Amount: is not a number."
+]}

data/spec/fixtures/component.json

@@ -0,0 +1,11 @@
+{
+  "component": {
+    "kind": "quantity_based_component",
+    "name": "Extra Rubies",
+    "allocated_quantity": 42,
+    "subscription_id": 16,
+    "pricing_scheme": "per_unit",
+    "component_id": 84,
+    "unit_name": "band"
+  }
+}

data/spec/fixtures/components.json

@@ -0,0 +1,24 @@
+[
+  {
+    "component": {
+      "kind": "quantity_based_component",
+      "name": "Extra Rubies",
+      "allocated_quantity": 42,
+      "subscription_id": 16,
+      "pricing_scheme": "per_unit",
+      "component_id": 84,
+      "unit_name": "band"
+    }
+  },
+  {
+    "component": {
+      "kind": "quantity_based_component",
+      "name": "IP addresses",
+      "allocated_quantity": 2,
+      "subscription_id": 16,
+      "pricing_scheme": "per_unit",
+      "component_id": 24,
+      "unit_name": "address"
+    }
+  }
+]

data/spec/fixtures/customer.json

@@ -0,0 +1,12 @@
+{
+    "customer": {
+        "reference": "bradleyjoyce",
+        "updated_at": "2009-10-07T11:10:27-04:00",
+        "id": 16,
+        "organization": "Squeejee",
+        "first_name": "Bradley",
+        "last_name": "Joyce",
+        "email": "bradley@squeejee.com",
+        "created_at": "2009-10-07T11:10:27-04:00"
+    }
+}

data/spec/fixtures/customers.json

@@ -0,0 +1,12 @@
+[{
+    "customer": {
+        "reference": "bradleyjoyce",
+        "updated_at": "2009-10-07T11:10:27-04:00",
+        "id": 16,
+        "organization": "Squeejee",
+        "first_name": "Bradley",
+        "last_name": "Joyce",
+        "email": "bradley@squeejee.com",
+        "created_at": "2009-10-07T11:10:27-04:00"
+    }
+}]

data/spec/fixtures/deleted_subscription.json

@@ -0,0 +1 @@
+{"created_at":"Tue Jan 26 18:40:32 -0600 2010","activated_at":"Tue Jan 26 18:40:33 -0600 2010","expires_at":null,"cancellation_message":"Optional message","trial_ended_at":null,"updated_at":"Tue Jan 26 18:40:35 -0600 2010","credit_card":{"card_type":"bogus","expiration_year":2013,"masked_card_number":"XXXX-XXXX-XXXX-1","expiration_month":3,"last_name":"Indicisive","first_name":"John"},"id":3642,"current_period_ends_at":"Fri Feb 26 18:40:32 -0600 2010","product":{"product_family":{"name":"ZipZoomAuto","handle":"zipzoomauto","accounting_code":null,"id":268,"description":""},"name":"Basic Plan","handle":"basic","price_in_cents":5000,"accounting_code":"","id":689,"interval":1,"description":"","interval_unit":"month"},"success?":true,"customer":{"reference":"11654","created_at":"Tue Jan 26 18:40:32 -0600 2010","updated_at":"Tue Jan 26 18:40:32 -0600 2010","id":3546,"last_name":"Indicisive","organization":null,"email":"john@doe.com","first_name":"John"},"trial_started_at":null,"balance_in_cents":0,"current_period_started_at":"Tue Jan 26 18:40:32 -0600 2010","state":"canceled"}

data/spec/fixtures/invalid_subscription.json

@@ -0,0 +1,48 @@
+    "subscription": {
+        "customer": {
+            "reference": "bradleyjoyce",
+            "updated_at": "2009-10-07T11:10:27-04:00",
+            "id": 16,
+            "organization": "Squeejee",
+            "first_name": "Bradley",
+            "last_name": "Joyce",
+            "email": "bradley@squeejee.com",
+            "created_at": "2009-10-07T11:10:27-04:00"
+        },
+        "cancellation_message": null,
+        "updated_at": "2009-10-07T11:10:56-04:00",
+        "expires_at": null,
+        "activated_at": "2009-10-23T16:16:59-04:00",
+        "current_period_started_at": "2009-11-14T11:10:56-05:00",
+        "credit_card": {
+            "card_type": "bogus",
+            "expiration_year": 2015,
+            "masked_card_number": "XXXX-XXXX-XXXX-1",
+            "first_name": "Bradley",
+            "last_name": "Joyce",
+            "expiration_month": 7
+        },
+        "trial_ended_at": "2009-10-14T11:10:56-04:00",
+        "id": 14,
+        "product": {
+            "price_in_cents": 500,
+            "name": "Monthly",
+            "handle": "monthly",
+            "id": 8,
+            "accounting_code": "TSMO",
+            "product_family": {
+                "name": "TweetSaver",
+                "handle": "tweetsaver",
+                "id": 7,
+                "accounting_code": null
+            },
+            "interval_unit": "month",
+            "interval": 1
+        },
+        "current_period_ends_at": "2009-12-14T11:10:56-05:00",
+        "trial_started_at": "2009-10-07T11:10:56-04:00",
+        "balance_in_cents": 0,
+        "state": "active",
+        "created_at": "2009-10-07T11:10:56-04:00"
+    }
+}

data/spec/fixtures/list_metered_subscriptions.json

@@ -0,0 +1,3 @@
+{
+  "usages": []
+}

data/spec/fixtures/migrate_subscription.json

@@ -0,0 +1,51 @@
+{
+    "subscription": {
+        "id": 123,
+        "state": "active",
+        "balance_in_cents": "auto generated",
+        "current_period_started_at": "auto generated",
+        "current_period_ends_at": "auto generated",
+        "activated_at": "auto generated",
+        "trial_ended_at": "auto generated",
+        "trial_started_at": "auto generated",
+        "expires_at": "auto generated",
+        "created_at": "auto generated",
+        "updated_at": "auto generated",
+        "cancellation_message": null,
+        "customer": {
+            "id": "auto generated",
+            "first_name": "your value",
+            "last_name": "your value",
+            "email": "your value",
+            "organization": "your value",
+            "reference": "your value",
+            "updated_at": "auto generated",
+            "created_at": "auto generated"
+        },
+        "product": {
+            "id": 354,
+            "name": "[@products.last.name]",
+            "handle": 354,
+            "price_in_cents": 1000,
+            "accounting_code": "[@products.last.accounting_code]",
+            "description": "your value",
+            "interval": 3600,
+            "interval_unit": "[@products.last.interval_unit]",
+            "product_family": {
+                "id": 15,
+                "name": "[@products.last.product_family.name]",
+                "handle": "[@products.last.product_family.handle]",
+                "accounting_code": "[@products.last.product_family.accounting_code]",
+                "description": "your value"
+            }
+        },
+        "credit_card": {
+            "first_name": "your value",
+            "last_name": "your value",
+            "masked_card_number": "your value",
+            "card_type": "auto generated",
+            "expiration_month": "your value",
+            "expiration_year": "your value"
+        }
+    }
+}

data/spec/fixtures/new_customer.json

@@ -0,0 +1,12 @@
+{
+    "customer": {
+        "created_at": "2009-11-18T10:56:22-05:00", 
+        "email": "wynn.netherland@gmail.com", 
+        "first_name": "Wynn", 
+        "id": 333, 
+        "last_name": "Netherland", 
+        "organization": null, 
+        "reference": null, 
+        "updated_at": "2009-11-18T10:56:22-05:00"
+    }
+}