twocheckout 0.1.0 → 0.1.1

data/.gitignore

@@ -0,0 +1,5 @@
+*~
+*.lock
+*.DS_Store
+*.swp
+*.out

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2012 - Craig Christenson
+
+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.md

@@ -0,0 +1,176 @@
+2Checkout Ruby Library
+=====================
+
+This library provides developers with a simple set of bindings to the 2Checkout purchase routine, Instant Notification Service and Back Office API.
+
+To use, install the `twocheckout` gem.
+
+```shell
+gem install twocheckout
+```
+
+Or import into your Gemfile.
+
+```ruby
+gem "twocheckout", "~> 0.1.0"
+```
+
+Full documentation for each binding is provided in the **[Wiki](https://github.com/craigchristenson/2checkout-ruby/wiki)**.
+
+
+Example API Usage
+-----------------
+
+*Example Usage:*
+
+```ruby
+Twocheckout::API.credentials = { :username => 'APIuser1817037', :password => 'APIpass1817037' }
+
+sale = Twocheckout::Sale.find(:sale_id => 4838212958)
+sale.stop_recurring!
+```
+
+*Example Response:*
+
+```ruby
+[
+    #<Twocheckout: : LineItem: 4838213015>{
+        "affiliate_vendor_id"=>nil,
+        "billing"=>#<Twocheckout: : HashObject: 70259731127120>{
+            "amount"=>"0.01",
+            "bill_method"=>"paypal_int",
+            "billing_id"=>"4838213024",
+            "customer_amount"=>"0.01",
+            "customer_id"=>"4838212964",
+            "date_deposited"=>nil,
+            "date_end"=>nil,
+            "date_fail"=>"2012-10-30",
+            "date_next"=>"2012-10-30",
+            "date_pending"=>"2012-10-23",
+            "date_start"=>"2012-10-25",
+            "lineitem_id"=>"4838213015",
+            "recurring_status"=>"active",
+            "status"=>"bill",
+            "usd_amount"=>"0.01",
+            "vendor_amount"=>"0.01"
+        },
+        "commission"=>nil,
+        "commission_affiliate_vendor_id"=>nil,
+        "commission_flat_rate"=>nil,
+        "commission_percentage"=>nil,
+        "commission_type"=>nil,
+        "commission_usd_amount"=>nil,
+        "customer_amount"=>"0.01",
+        "flat_rate"=>nil,
+        "installment"=>"1",
+        "invoice_id"=>"4838212967",
+        "lc_affiliate_vendor_id"=>nil,
+        "lc_usd_amount"=>nil,
+        "lineitem_id"=>"4838213015",
+        "linked_id"=>nil,
+        "options"=>[
+            {
+                "customer_surcharge"=>"0.01",
+                "lineitem_id"=>"4838213015",
+                "lineitem_option_id"=>"4838213021",
+                "option_name"=>"0.5",
+                "option_value"=>"test1",
+                "usd_surcharge"=>"0.01",
+                "vendor_surcharge"=>"0.01"
+            }
+        ],
+        "percentage"=>nil,
+        "product_description"=>"This is a test product!",
+        "product_duration"=>"Forever",
+        "product_handling"=>"0.00",
+        "product_id"=>"4774388564",
+        "product_is_cart"=>"0",
+        "product_name"=>"Example Product",
+        "product_price"=>"0.01",
+        "product_recurrence"=>"1 Week",
+        "product_startup_fee"=>nil,
+        "product_tangible"=>"0",
+        "sale_id"=>"4838212958",
+        "status"=>"bill",
+        "type"=>nil,
+        "usd_amount"=>"0.01",
+        "usd_commission"=>nil,
+        "vendor_amount"=>"0.01",
+        "vendor_product_id"=>"example123"
+    }
+]
+```
+
+Example Checkout Usage:
+-----------------------
+
+*Example Usage:*
+
+```ruby
+require "sinatra"
+
+get '/' do
+  @@form = Twocheckout::Checkout.submit({ 'sid' => '1817037', 'mode' => '2CO','li_0_name' => 'Example Product', 'li_0_price' => '1.00'})
+  @@form
+end
+```
+
+*Example Response:*
+
+```html
+<form id="2checkout" action="https://www.2checkout.com/checkout/spurchase" method="post">
+<input type="hidden" name="sid" value="1817037" />
+<input type="hidden" name="mode" value="2CO" />
+<input type="hidden" name="li_0_name" value="Example Product" />
+<input type="hidden" name="li_0_price" value="1.00" />
+</form>
+<script type="text/javascript">document.getElementById('2checkout').submit();</script>
+```
+
+Example Return Usage:
+---------------------
+
+*Example Usage:*
+
+```ruby
+require "sinatra"
+
+post '/' do
+  @@response = Twocheckout::ValidateResponse.purchase({:sid => 1817037, :secret => "tango", :order_number => params[:order_number], :total => params[:total], :key => params[:key]})
+  @@response.inspect
+end
+```
+
+*Example Response:*
+
+```ruby
+{
+    :code => "PASS",
+    :message => "Hash Matched"
+}
+```
+
+Example INS Usage:
+------------------
+
+*Example Usage:*
+
+```ruby
+require "sinatra"
+
+post '/' do
+ @@response = Twocheckout::ValidateResponse.notification({:sale_id => params[:sale_id], :vendor_id => 1817037, :invoice_id => params[:invoice_id], :secret => "tango", :md5_hash => params[:md5_hash]})
+ @@response.inspect
+end
+```
+
+*Example Response:*
+
+```ruby
+{
+    :code => "PASS",
+    :message => "Hash Matched"
+}
+```
+
+Full documentation for each binding is provided in the **[Wiki](https://github.com/craigchristenson/2checkout-ruby/wiki)**.

data/lib/twocheckout/api.rb

@@ -0,0 +1,49 @@
+require 'rest_client'
+require 'json'
+
+module Twocheckout
+  class API
+    API_BASE = 'https://www.2checkout.com/api/'
+
+    def self.credentials=(opts)
+      @@username = opts[:username]
+      @@password = opts[:password]
+      opts
+    end
+
+    def self.request(http_method, api_call, params = nil)
+      url = API_BASE + api_call
+      if http_method == :get
+        url += hash_to_querystring(params)
+        params = nil
+      end
+      opts = {
+        :method => http_method,
+        :url => url,
+        :headers => {
+            :accept => :json,
+            :content_type => :json,
+            :user_agent => "2Checkout/Ruby/," + Twocheckout::VERSION
+        },
+        :user => @@username,
+        :password => @@password,
+        :payload => params,
+      }
+      begin
+        response = RestClient::Request.execute(opts)
+        JSON.parse(response)
+      rescue => e
+        error_hash = JSON.parse(e.response)
+        raise TwocheckoutError.new(error_hash['errors'][0]['message']).retrieve
+      end
+    end
+
+    private
+
+    def self.hash_to_querystring(hash)
+      return '' if hash.nil? || hash.empty?
+      '?' + hash.map { |k,v| "#{URI.encode(k.to_s)}=#{URI.encode(v.to_s)}" }.join('&')
+    end
+
+  end
+end

data/lib/twocheckout/checkout.rb

@@ -0,0 +1,26 @@
+module Twocheckout
+  class Checkout
+
+    def self.form(params={})
+      @form = "<form id=\"2checkout\" action=\"https://www.2checkout.com/checkout/spurchase\" method=\"post\">\n";
+      params.each do |k,v|
+        @form = @form + "<input type=\"hidden\" name=\"" + k + "\" value=\"" + v.to_s + "\" />\n"
+      end
+      @form + "<input type=\"submit\" value=\"Proceed to Checkout\" />\n</form>"
+    end
+
+    def self.submit(params={})
+      @form = "<form id=\"2checkout\" action=\"https://www.2checkout.com/checkout/spurchase\" method=\"post\">\n";
+      params.each do |k,v|
+        @form = @form + "<input type=\"hidden\" name=\"" + k + "\" value=\"" + v.to_s + "\" />\n"
+      end
+      @form = @form + "</form>\n"
+      @form = @form + "<script type=\"text/javascript\">document.getElementById('2checkout').submit();</script>"
+    end
+
+    def self.link(params={}, url="https://www.2checkout.com/checkout/spurchase?")
+      @querystring = params.map{|k,v| "#{CGI.escape(k)}=#{CGI.escape(v)}"}.join("&")
+      @purchase_url = url + @querystring
+    end
+  end
+end

data/lib/twocheckout/company.rb

@@ -0,0 +1,33 @@
+require 'singleton'
+
+module Twocheckout
+  class Company < HashObject
+    include Singleton
+
+    #
+    # Returns company info
+    #
+    def initialize
+      response = Twocheckout::API.request(:get, 'acct/detail_company_info')
+      super(response['vendor_company_info'])
+    end
+
+    #
+    # Returns contact info
+    #
+    def contact_info
+      if @contact_info.nil?
+        response = Twocheckout::API.request(:get, 'acct/detail_contact_info')
+        @contact_info = HashObject.new(response['vendor_contact_info'])
+      end
+      @contact_info
+    end
+
+    protected
+
+    def _key
+      self.vendor_id
+    end
+
+  end
+end

data/lib/twocheckout/coupon.rb

@@ -0,0 +1,41 @@
+module Twocheckout
+  class Coupon < HashObject
+
+    def self.find(options)
+      response = Twocheckout::API.request(:get, 'products/detail_coupon', options)
+      Coupon.new(response['coupon'])
+    end
+
+    def self.with_coupon_code(coupon_code)
+      find(:coupon_code => coupon_code)
+    end
+
+    def self.create(opts)
+      response = Twocheckout::API.request(:post, 'products/create_coupon', opts)
+      find(:coupon_code => response['coupon_code'])
+    end
+
+    def update(opts)
+      opts = opts.merge(:coupon_code => self.coupon_code)
+      Twocheckout::API.request(:post, 'products/update_coupon', opts)
+      response = Twocheckout::API.request(:get, 'products/detail_coupon', opts)
+      Coupon.new(response['coupon'])
+    end
+
+    def delete!
+      opts = {:coupon_code => self.coupon_code}
+      Twocheckout::API.request(:post, 'products/delete_coupon', opts)
+    end
+
+    def self.list(opts=nil)
+      Twocheckout::API.request(:get, 'products/list_coupons', opts)
+    end
+
+    protected
+
+    def _key
+      self.coupon_code
+    end
+
+  end
+end

data/lib/twocheckout/hash_object.rb

@@ -0,0 +1,44 @@
+require "pp"
+
+module Twocheckout
+  class HashObject
+
+    def initialize(hash)
+      @hash = hash
+    end
+
+    def method_missing(name)
+      name = name.to_s
+      if @hash.key? name
+        result = @hash[name]
+        if result.is_a?(Hash)
+          result = HashObject.new(result)
+          @hash[name] = result
+        end
+        if result.is_a?(Array)
+          new_array = []
+          result.each do |item|
+            new_item = item.is_a?(Hash) ? HashObject.new(item) : item
+            new_array << new_item
+          end
+          new_array.freeze
+          result = new_array
+          @hash[name] = result
+        end
+        return result
+      end
+      super.method_missing name
+    end
+
+    def inspect
+      "#<#{self.class.name}:#{self._key}> #{pp @hash}"
+    end
+
+    protected
+
+    def _key
+      self.object_id.to_s
+    end
+
+  end
+end

data/lib/twocheckout/invoice.rb

@@ -0,0 +1,58 @@
+module Twocheckout
+  class Invoice < HashObject
+
+    def self.find(options)
+      response = Twocheckout::API.request(:get, 'sales/detail_sale', options)
+      Sale.new(response['sale']).invoice[options[:invoice_id]]
+    end
+
+    #
+    # An array of all line-items in this invoice
+    #
+    def lineitems
+      if @lineitems.nil?
+        @lineitems = @hash['lineitems'].map { |li| Twocheckout::LineItem.new(li) }
+        @lineitems.freeze
+      end
+      @lineitems
+    end
+
+    #
+    # A hash to index line-items by id
+    #
+    def lineitem
+      if @lineitem.nil?
+        @lineitem = {}
+        lineitems.each { |li| @lineitem[li.lineitem_id] = li }
+        @lineitem.freeze
+      end
+      return @lineitem
+    end
+
+    #
+    # Refund invoice
+    #
+    def refund!(opts)
+      opts = opts.merge(:invoice_id => self.invoice_id)
+      Twocheckout::API.request(:post, 'sales/refund_invoice', opts)
+    end
+
+    #
+    # Get active recurring lineitems
+    #
+    def active_lineitems
+      @active_lineitems ||= lineitems.select(&:active?).freeze
+    end
+
+    def stop_recurring!
+      active_lineitems.each { |li| li.stop_recurring! }
+    end
+
+    protected
+
+    def _key
+      self.invoice_id
+    end
+
+  end
+end

data/lib/twocheckout/lineitem.rb

@@ -0,0 +1,57 @@
+module Twocheckout
+  class LineItem < HashObject
+
+    def refund!(opts)
+      opts = opts.merge(:lineitem_id => self.lineitem_id)
+      Twocheckout::API.request(:post, 'sales/refund_lineitem', opts)
+    end
+
+    def active?
+      self.billing.recurring_status == 'active'
+    end
+
+    def stop_recurring!
+      Twocheckout::API.request(:post, 'sales/stop_lineitem_recurring', lineitem_id: self.lineitem_id)
+    end
+
+    #
+    # Provide access to update existing recurring lineitems by allowing to lower the lineitem price
+    # and push the recurring billing date forward. This call is not currently documented in the
+    # 2Checkout API documentation.
+    #
+    # POST https://www.2checkout.com/api/sales/update_lineitem_recurring
+    #
+    # Parameters:
+    # * (required) lineitem_id: lineitem_id
+    # * (optional) comment: Optional comment added to sale
+    # * (optional) shift: days to shift next recurring payment forward
+    # * (optional) price: new recurring price (must be lower than previous price or else call will fail)
+    #
+    # The shift and price parameters are optional, but at least one of them must be provided for the
+    # call to be valid.
+    #
+    # Example Shift Date Next
+    # curl -X POST https://www.2checkout.com/api/sales/update_lineitem_recurring -u \
+    # 'username:password' -d 'lineitem_id=1234567890' -d 'shift=7' -H 'Accept: application/json'
+    #
+    # Example Update Price
+    # curl -X POST https://www.2checkout.com/api/sales/update_lineitem_recurring -u \
+    # 'username:password' -d 'lineitem_id=1234567890' -d 'price=1.00' -H 'Accept: application/json'
+    #
+    # Please note that this method cannot be used on PayPal sales as 2Checkout cannot alter the
+    # customer's billing agreement so this call can only update a recurring lineitem on credit card
+    # sales.
+    #
+    def update_recurring!(opts)
+      opts = opts.merge(:lineitem_id => self.lineitem_id)
+      Twocheckout::API.request(:post, 'sales/update_lineitem_recurring', opts)
+    end
+
+    protected
+
+    def _key
+      self.lineitem_id
+    end
+
+  end
+end

data/lib/twocheckout/option.rb

@@ -0,0 +1,57 @@
+module Twocheckout
+  class Option < HashObject
+
+    #
+    # Finds option by ID and returns a Option object
+    #
+    def self.find(options)
+      response = Twocheckout::API.request(:get, 'products/detail_option', options)
+      Option.new(response['option'][0])
+    end
+
+    def self.with_option_id(option_id)
+      find(:option_id => option_id)
+    end
+
+    #
+    # Creates a new product option
+    #
+    def self.create(opts)
+      response = Twocheckout::API.request(:post, 'products/create_option', opts)
+      find(:option_id => response['option_id'])
+    end
+
+    #
+    # Updates option and returns a new object
+    #
+    def update(opts)
+      opts = opts.merge(:option_id => self.option_id)
+      Twocheckout::API.request(:post, 'products/update_option', opts)
+      response = Twocheckout::API.request(:get, 'products/detail_option', opts)
+      Option.new(response['option'][0])
+    end
+
+    #
+    # Deletes the option and returns the response
+    #
+    def delete!
+      opts = {:option_id => self.option_id}
+      Twocheckout::API.request(:post, 'products/delete_option', opts)
+    end
+
+    #
+    # An array to index options list
+    #
+    def self.list(opts=nil)
+      response = Twocheckout::API.request(:get, 'products/list_options', opts)
+      response['options']
+    end
+
+    protected
+
+    def _key
+      self.option_id
+    end
+
+  end
+end

data/lib/twocheckout/product.rb

@@ -0,0 +1,57 @@
+module Twocheckout
+  class Product < HashObject
+
+    #
+    # Finds product by ID and returns a Product object
+    #
+    def self.find(opts)
+      response = Twocheckout::API.request(:get, 'products/detail_product', opts)
+      Product.new(response['product'])
+    end
+
+    def self.with_product_id(product_id)
+      find(:product_id => product_id)
+    end
+
+    #
+    # Creates a new product and returns the Product object
+    #
+    def self.create(opts)
+      response = Twocheckout::API.request(:post, 'products/create_product', opts)
+      find(:product_id => response['product_id'])
+    end
+
+    #
+    # Updates product and returns a new Product object
+    #
+    def update(opts)
+      opts = opts.merge(:product_id => self.product_id)
+      Twocheckout::API.request(:post, 'products/update_product', opts)
+      response = Twocheckout::API.request(:get, 'products/detail_product', opts)
+      Product.new(response['product'])
+    end
+
+    #
+    # Deletes the product and returns the response
+    #
+    def delete!
+      opts = {:product_id => self.product_id}
+      Twocheckout::API.request(:post, 'products/delete_product', opts)
+    end
+
+    #
+    # Get product list in an array
+    #
+    def self.list(opts)
+      response = Twocheckout::API.request(:get, 'products/list_products', opts)
+      response['products']
+    end
+
+    protected
+
+    def _key
+      self.product_id
+    end
+
+  end
+end

data/lib/twocheckout/sale.rb

@@ -0,0 +1,100 @@
+module Twocheckout
+  class Sale < HashObject
+
+    def self.find(options)
+      response = Twocheckout::API.request(:get, 'sales/detail_sale', options)
+      Sale.new(response['sale'])
+    end
+
+    def self.with_sale_id(sale_id)
+      find(:sale_id => sale_id)
+    end
+
+    def self.with_invoice_id(invoice_id)
+      find(:invoice_id => invoice_id)
+    end
+
+    #
+    # An array of all invoices in this sale
+    #
+    def invoices
+      if @invoices.nil?
+        @invoices = @hash['invoices'].map { |i| Twocheckout::Invoice.new(i) }
+        @invoices.freeze
+      end
+      @invoices
+    end
+
+    #
+    # A hash to index invoices by id
+    #
+    def invoice
+      if @invoice.nil?
+        @invoice = {}
+        invoices.each { |inv| @invoice[inv.invoice_id] = inv }
+        @invoice.freeze
+      end
+      return @invoice
+    end
+
+    #
+    # Refund sale
+    #
+    def refund!(opts)
+      opts = opts.merge(:sale_id => self.sale_id)
+      Twocheckout::API.request(:post, 'sales/refund_invoice', opts)
+    end
+
+    #
+    # Get active recurring lineitems from the most recent invoice
+    #
+    def active_lineitems
+      invoices.last.active_lineitems
+    end
+
+    #
+    # Stop all active recurring lineitems
+    #
+    def stop_recurring!
+      active_lineitems.each { |li| li.stop_recurring! }
+    end
+
+    #
+    # Add a sale comment
+    #
+    def comment(opts)
+      opts = opts.merge(:sale_id => self.sale_id)
+      Twocheckout::API.request(:post, 'sales/create_comment', opts)
+    end
+
+    #
+    # Mark tangible sale as shipped
+    #
+    def ship(opts)
+      opts = opts.merge(:sale_id => self.sale_id)
+      Twocheckout::API.request(:post, 'sales/mark_shipped', opts)
+    end
+
+    #
+    # Reauthorize sale
+    #
+    def reauth
+      Twocheckout::API.request(:post, 'sales/reauth', sale_id: self.sale_id)
+    end
+
+    #
+    # Get sale list in an array
+    #
+    def self.list(opts)
+      response = Twocheckout::API.request(:get, 'sales/list_sales', opts)
+      response['sale_summary']
+    end
+
+    protected
+
+    def _key
+      self.sale_id
+    end
+
+  end
+end

data/lib/twocheckout/twocheckout_error.rb

@@ -0,0 +1,18 @@
+module Twocheckout
+  class TwocheckoutError < StandardError
+    attr_reader :message
+
+    def initialize(message)
+      @message = message
+    end
+
+    def retrieve
+      if @message.is_a?(Hash)
+        @message = JSON.generate(@message)
+        "#{@message}"
+      else
+        "#{@message}"
+      end
+    end
+  end
+end

data/lib/twocheckout/validate_response.rb

@@ -0,0 +1,28 @@
+require 'digest/md5'
+
+module Twocheckout
+  class ValidateResponse
+
+    # Checks against MD5 Hash
+    def self.valid?(arg1, arg2, arg3, arg4, key)
+      Digest::MD5.hexdigest("#{arg1}#{arg2}#{arg3}#{arg4}").upcase == key
+    end
+
+    def self.purchase(options)
+      options[:demo] == 'Y' ? 1 : options[:order_number]
+      if valid?(options[:secret], options[:sid], options[:order_number], options[:total], options[:key])
+        {:code => "PASS", :message => "Hash Matched"}
+      else
+        {:code => "FAIL", :message => "Hash Mismatch"}
+      end
+    end
+
+    def self.notification(options)
+      if valid?(options[:sale_id], options[:vendor_id], options[:invoice_id], options[:secret], options[:md5_hash])
+        {:code => "PASS", :message => "Hash Matched"}
+      else
+        {:code => "FAIL", :message => "Hash Mismatch"}
+      end
+    end
+  end
+end

data/lib/twocheckout/version.rb

@@ -0,0 +1,3 @@
+module Twocheckout
+  VERSION = "0.1.1"
+end

data/lib/twocheckout.rb

@@ -0,0 +1,13 @@
+require "twocheckout/version"
+require "twocheckout/api"
+require "twocheckout/hash_object"
+require "twocheckout/validate_response"
+require "twocheckout/company"
+require "twocheckout/lineitem"
+require "twocheckout/invoice"
+require "twocheckout/sale"
+require "twocheckout/coupon"
+require "twocheckout/product"
+require "twocheckout/option"
+require "twocheckout/checkout"
+require "twocheckout/twocheckout_error"

data/test/test_twocheckout.rb

@@ -0,0 +1,252 @@
+require "minitest/spec"
+require "minitest/autorun"
+require "twocheckout"
+
+#
+# Sales
+#
+describe Twocheckout::Sale do
+  before do
+    Twocheckout::API.credentials = { :username => 'APIuser1817037', :password => 'APIpass1817037' }
+  end
+
+  #retrieve sale
+  it "Sale retrieve returns sale" do
+    sale = Twocheckout::Sale.find(:sale_id => 4786293822)
+    assert_equal('4786293822', sale.sale_id)
+  end
+
+  #retrieve invoice
+  it "Sale retrieve returns invoice" do
+    invoice = Twocheckout::Sale.find({:invoice_id => 4786293831})
+    assert_equal('4786293831', invoice.invoice_id)
+  end
+
+  #retrieve sale list
+  it "Sale list returns list" do
+    sale_list = Twocheckout::Sale.list({:pagesize => 5})
+    assert_equal(5, sale_list.size)
+  end
+
+  #refund sale
+  it "Refunding a refunded sale returns exception" do
+  	begin
+	  sale = Twocheckout::Sale.find(:sale_id => 4786293822)
+	  sale.refund!({:comment => "test refund", :category => 1})
+    rescue Exception => e
+	  assert_equal("Invoice was already refunded.", e.message)
+    end
+  end
+
+  #refund invoice
+  it "Refunding a refunded invoice returns exception" do
+  	begin
+	  sale = Twocheckout::Sale.find(:sale_id => 4786293822)
+	  invoice = sale.invoices.first
+	  invoice.refund!({:comment => "test refund", :category => 1})
+    rescue Exception => e
+	  assert_equal("Invoice was already refunded.", e.message)
+    end
+  end
+
+  #refund lineitem
+  it "Refunding a refunded lineitem returns exception" do
+  	begin
+	  sale = Twocheckout::Sale.find(:sale_id => 4786293822)
+	  first_invoice = sale.invoices.first
+	  last_lineitem = first_invoice.lineitems.last
+	  last_lineitem.refund!({:comment => "test refund", :category => 1})
+    rescue Exception => e
+	  assert_equal("This lineitem cannot be refunded.", e.message)
+    end
+  end
+
+  #stop recurring lineitem
+  it "Stopping a stopped recurring lineitem returns exception" do
+  	begin
+	  sale = Twocheckout::Sale.find(:sale_id => 4786293822)
+	  result = sale.stop_recurring!
+	  assert_equal(result, [])
+    rescue Exception => e
+	  assert_equal("Lineitem is not scheduled to recur.", e.message)
+    end
+  end
+
+  #stop recurring sale
+  it "Stopping a stopped recurring sale returns exception" do
+  	begin
+	  sale = Twocheckout::Sale.find(:sale_id => 4786293822)
+	  last_invoice = sale.invoices.last
+	  last_lineitem = last_invoice.lineitems.last
+	  last_lineitem.stop_recurring!
+    rescue Exception => e
+	  assert_equal("Lineitem is not scheduled to recur.", e.message)
+    end
+  end
+
+  #create comment
+  it "Creates a sale comment" do
+  	sale = Twocheckout::Sale.find(:sale_id => 4786293822)
+    result = sale.comment({:sale_comment => "test"})
+    assert_equal('Created comment successfully.', result['response_message'])
+  end
+
+  #mark shipped
+  it "Shipping an intangible sale returns exception" do
+  	begin
+	  sale = Twocheckout::Sale.find(:sale_id => 4786293822)
+	  sale.ship({:tracking_number => "123"})
+    rescue Exception => e
+	  assert_equal("Item not shippable.", e.message)
+    end
+  end
+
+  #reauth
+  it "Reauthorizing a pending sale returns exception" do
+  	begin
+	  sale = Twocheckout::Sale.find(:sale_id => 4786293822)
+	  sale.reauth
+    rescue Exception => e
+	  assert_equal("Payment is already pending or deposited and cannot be reauthorized.", e.message)
+    end
+  end
+end
+
+#
+# Products
+#
+
+describe Twocheckout::Product do
+  before do
+    Twocheckout::API.credentials = { :username => 'APIuser1817037', :password => 'APIpass1817037' }
+  end
+
+  # Product list
+  it "Product list returns array of products" do
+    product_list = Twocheckout::Product.list({ :pagesize => 5 })
+	assert_equal(product_list.size, 5)
+  end
+
+  # Product CRUD
+   it "Product create, find, update, delete is successful" do
+   	# create
+    new_product = Twocheckout::Product.create({:name => "test product", :price => 1.00})
+	assert_equal("test product", new_product.name)
+	# find
+	product = Twocheckout::Product.find({:product_id => new_product.product_id})
+	assert_equal(new_product.product_id, product.product_id)
+	# update
+	product = product.update({:name => "new name"})
+	assert_equal("new name", product.name)
+	# delete
+	result = product.delete!
+	assert_equal("Product successfully deleted.", result['response_message'])
+  end
+end
+
+describe Twocheckout::Option do
+  before do
+    Twocheckout::API.credentials = { :username => 'APIuser1817037', :password => 'APIpass1817037' }
+  end
+
+  # Option list
+  it "Option list returns array of options" do
+    option_list = Twocheckout::Option.list({ :pagesize => 5 })
+	assert_equal(5, option_list.size)
+  end
+
+  # Option CRUD
+   it "Option create, find, update, delete is successful" do
+   	# create
+    new_option = Twocheckout::Option.create({:option_name => "test option", 
+    	:option_value_name => "test option value", :option_value_surcharge => 1.00})
+	assert_equal("test option", new_option.option_name)
+	# find
+	option = Twocheckout::Option.find({:option_id => new_option.option_id})
+	assert_equal(new_option.option_id, option.option_id)
+	# update
+	option = option.update({:option_name => "new name"})
+	assert_equal("new name", option.option_name)
+	# delete
+	result = option.delete!
+	assert_equal("Option deleted successfully", result['response_message'])
+  end
+end
+
+describe Twocheckout::Coupon do
+  before do
+    Twocheckout::API.credentials = { :username => 'APIuser1817037', :password => 'APIpass1817037' }
+  end
+
+  # Coupon list
+  it "Coupon list returns array of coupons" do
+    coupon_list = Twocheckout::Coupon.list({ :pagesize => 4 })
+	assert_equal(4, coupon_list.size)
+  end
+
+  # Coupon CRUD
+   it "Coupon create, find, update, delete is successful" do
+   	# create
+    new_coupon = Twocheckout::Coupon.create({:date_expire => "2020-01-01", 
+    	:type => "shipping", :minimum_purchase => 1.00})
+	assert_equal("2020-01-01", new_coupon.date_expire)
+	# find
+	coupon = Twocheckout::Coupon.find({:coupon_code => new_coupon.coupon_code})
+	assert_equal(new_coupon.coupon_code, coupon.coupon_code)
+	# update
+	coupon = coupon.update({:date_expire => "2020-01-02"})
+	assert_equal("2020-01-02", coupon.date_expire)
+	# delete
+	result = coupon.delete!
+	assert_equal("Coupon successfully deleted.", result['response_message'])
+  end
+end
+
+describe Twocheckout::ValidateResponse do
+  #purchase
+  it "Validates Purchase MD5 Hash" do
+    result = Twocheckout::ValidateResponse.purchase({:sid => 1817037, :secret => "tango", :order_number => 4789848870, :total => 0.01,
+                             :key => 'CDF3E502AA1597DD4401760783432337'})
+    assert_equal('PASS', result[:code])
+  end
+
+  #notification
+  it "Validates Notification MD5 Hash" do
+    result = Twocheckout::ValidateResponse.notification({:sale_id => 4789848870, :vendor_id => 1817037, :invoice_id => 4789848879, :secret => "tango",
+                             :md5_hash => '827220324C722873694758F38D8D3624'})
+    assert_equal('PASS', result[:code])
+  end
+end
+
+describe Twocheckout::Checkout do
+  #submit
+  it "Submit return a form + JS to submit" do
+    form = Twocheckout::Checkout.submit({ 'sid' => '1817037', 'cart_order_id' => 'Example Sale', 'total' => '1.00'})
+    @form = "<form id=\"2checkout\" action=\"https://www.2checkout.com/checkout/spurchase\" method=\"post\">\n" + 
+    "<input type=\"hidden\" name=\"sid\" value=\"1817037\" />\n" +
+    "<input type=\"hidden\" name=\"cart_order_id\" value=\"Example Sale\" />\n" +
+    "<input type=\"hidden\" name=\"total\" value=\"1.00\" />\n" +
+    "</form>\n" + 
+    "<script type=\"text/javascript\">document.getElementById('2checkout').submit();</script>"
+    assert_equal(form, @form)
+  end
+
+  #form
+  it "Form returns a form" do
+    form = Twocheckout::Checkout.form({ 'sid' => '1817037', 'cart_order_id' => 'Example Sale', 'total' => '1.00'})
+    @form = "<form id=\"2checkout\" action=\"https://www.2checkout.com/checkout/spurchase\" method=\"post\">\n" +
+    "<input type=\"hidden\" name=\"sid\" value=\"1817037\" />\n" +
+    "<input type=\"hidden\" name=\"cart_order_id\" value=\"Example Sale\" />\n" +
+    "<input type=\"hidden\" name=\"total\" value=\"1.00\" />\n" +
+    "<input type=\"submit\" value=\"Proceed to Checkout\" />\n" +
+    "</form>"
+    assert_equal(form, @form)
+  end
+
+  #link
+  it "Link returns a link" do
+    link = Twocheckout::Checkout.link({ 'sid' => '1817037', 'cart_order_id' => 'Example Sale', 'total' => '1.00'})
+    @link = "https://www.2checkout.com/checkout/spurchase?sid=1817037&cart_order_id=Example+Sale&total=1.00"
+    assert_equal(link, @link)
+  end
+end

data/twocheckout.gemspec

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'twocheckout'
+  s.version     = '0.1.1'
+  s.summary     = '2Checkout Ruby Library'
+  s.description = '0.1.1'
+  s.summary     = '2Checkout Ruby Library'
+  s.author        = "Craig Christenson", "Ernesto Garcia"
+  s.email         = 'christensoncraig@gmail.com'
+  s.homepage      = 'https://github.com/craigchristenson'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.add_dependency('rest-client', '~> 1.4')
+  s.require_paths = %w{lib}
+  s.requirements << 'none'
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twocheckout
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -19,7 +19,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.7
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,16 +27,33 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.7
-description: 0.1.0
-email:
-- christensoncraig@gmail.com
-- ernesto+git@gnapse.com
+        version: '1.4'
+description: 0.1.1
+email: christensoncraig@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage: http://github.com/craigchristenson
+files:
+- .gitignore
+- LICENSE
+- README.md
+- lib/twocheckout.rb
+- lib/twocheckout/api.rb
+- lib/twocheckout/checkout.rb
+- lib/twocheckout/company.rb
+- lib/twocheckout/coupon.rb
+- lib/twocheckout/hash_object.rb
+- lib/twocheckout/invoice.rb
+- lib/twocheckout/lineitem.rb
+- lib/twocheckout/option.rb
+- lib/twocheckout/product.rb
+- lib/twocheckout/sale.rb
+- lib/twocheckout/twocheckout_error.rb
+- lib/twocheckout/validate_response.rb
+- lib/twocheckout/version.rb
+- test/test_twocheckout.rb
+- twocheckout.gemspec
+homepage: https://github.com/craigchristenson
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -54,10 +71,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
+requirements:
+- none
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Ruby wrapper for 2Checkout API
-test_files: []
+summary: 2Checkout Ruby Library
+test_files:
+- test/test_twocheckout.rb