slidepay 0.0.2

data/lib/slidepay/config.rb

@@ -0,0 +1,7 @@
+module SlidePay
+  ENDPOINT_SUFFIX   = '/rest.svc/API/'
+  SUPERVISOR_URL    = 'https://supervisor.getcube.com:65532/rest.svc/API/'
+  PROD_API_URL      = 'https://api.getcube.com:65532/rest.svc/API/'
+  DEV_API_URL       = 'https://dev.getcube.com:65532/rest.svc/API/'
+  DEBUG             = false
+end

data/lib/slidepay/resources/api_key.rb

@@ -0,0 +1,11 @@
+module SlidePay
+  class ApiKey < ApiResource
+    def initialize(values_hash={})
+      @url_root = "api_key"
+      @id_attribute = "api_key_id"
+
+      super(values_hash)
+    end
+
+  end
+end

data/lib/slidepay/resources/api_resource.rb

@@ -0,0 +1,117 @@
+module SlidePay
+  class ApiResource < Hash
+    attr_accessor :url_root, :id_attribute, :token, :api_key, :endpoint
+
+    def initialize(values_hash={})
+      if values_hash[:url_root]
+        @url_root = values_hash[:url_root]
+        values_hash.delete(:url_root)
+      end
+
+      if values_hash[:id_attribute]
+        @id_attribute = values_hash[:id_attribute]
+        values_hash.delete(:id_attribute)
+      end
+
+      if values_hash[:token]
+        @token = values_hash[:token]
+        values_hash.delete(:token)
+      end
+
+      if values_hash[:api_key]
+        @api_key = values_hash[:api_key]
+        values_hash.delete(:api_key)
+      end
+
+      if values_hash[:endpoint]
+        @endpoint = values_hash[:endpoint]
+        values_hash.delete(:endpoint)
+      end
+
+      merge! values_hash
+    end
+
+    def url
+      if is_new?
+        @url_root
+      else
+        "#{@url_root}/#{self.id()}"
+      end
+    end
+
+    def id
+      self[@id_attribute]
+    end
+
+    def is_new?
+      if id() == nil
+        true
+      else
+        false
+      end
+    end
+
+    def populate_from_response(response)
+      if response.data.instance_of? Array
+        self.merge! response.data.first
+      elsif response.data.instance_of? Hash
+        self.merge! response.data
+      else
+        raise Exception.new("Resource with the specified id not found on the server.")
+      end
+    end
+
+    def retrieve(options_hash={})
+      token = @token || options_hash[:token]
+      api_key = @api_key || options_hash[:api_key]
+      endpoint = @endpoint || options_hash[:endpoint]
+
+      if is_new?
+        raise Exception.new("Cannot retrieve an unsaved object from the server.")
+      end
+
+      response = SlidePay.get(path: self.url(), token: token, api_key: api_key, endpoint: endpoint)
+      if response.was_successful?
+        self.populate_from_response(response)
+      end
+    end
+
+    def save(options_hash={})
+      token = @token || options_hash[:token]
+      api_key = @api_key || options_hash[:api_key]
+      endpoint = @endpoint || options_hash[:endpoint]
+
+      if is_new?
+        response = SlidePay.post(path: self.url(), token: token, api_key: api_key, endpoint: endpoint, data: self.to_json)
+      else
+        response = SlidePay.put(path: self.url(), token: token, api_key: api_key, endpoint: endpoint, data: self.to_json)
+      end
+
+      if response.was_successful?
+        self.populate_from_response(response)
+        true
+      else
+        false
+      end
+    end
+
+    def destroy(options_hash={})
+      token = @token || options_hash[:token]
+      api_key = @api_key || options_hash[:api_key]
+      endpoint = @endpoint || options_hash[:endpoint]
+
+      if is_new?
+        raise Exception.new("Cannot destroy a resource that has not been saved.")
+      end
+
+      response = SlidePay.delete(path: self.url(), token: token, api_key: api_key, endpoint: endpoint)
+
+      if response.was_successful?
+        self[@id_attribute] = nil
+        true
+      else
+        false
+      end
+    end
+  end
+end

data/lib/slidepay/resources/bank_account.rb

@@ -0,0 +1,11 @@
+module SlidePay
+  class BankAccount < ApiResource
+    def initialize(values_hash={})
+      @url_root = "bank_account"
+      @id_attribute = "bank_account_id"
+
+      super(values_hash)
+    end
+
+  end
+end

data/lib/slidepay/resources/payment.rb

@@ -0,0 +1,48 @@
+module SlidePay
+  class Payment < ApiResource
+    def initialize(values_hash={})
+      @id_attribute = "payment_id"
+      @url_root = "payment"
+
+      super(values_hash)
+    end
+
+    def save(options_hash={})
+      process(options_hash)
+    end
+
+    def destroy(options_hash={})
+      refund(options_hash)
+    end
+
+    def process(options_hash={})
+      token = @token || options_hash[:token]
+      api_key = @api_key || options_hash[:api_key]
+      endpoint = @endpoint || options_hash[:endpoint]
+
+      response = SlidePay.post(path: "payment/simple", api_key: api_key, token: token, endpoint: endpoint, data: self.to_json)
+
+      if response.was_successful?
+        self["payment_id"] = response.data["payment_id"]
+        self["order_master_id"] = response.data["order_master_id"]
+        true
+      elsif response.error_text
+        raise Exception.new(response.error_text)
+      elsif response.data["status_message"]
+        raise Exception.new(response.data["status_message"])
+      else
+        raise Exception.new("Payment could not be processed.")
+      end
+    end
+
+    def refund(options_hash={})
+      token = @token || options_hash[:token]
+      api_key = @api_key || options_hash[:api_key]
+      endpoint = @endpoint || options_hash[:endpoint]
+
+      response = SlidePay.post(path: "payment/refund/#{self.id()}", api_key: api_key, token: token, endpoint: endpoint, data: self.to_json)
+
+      response.was_successful?
+    end
+  end
+end

data/lib/slidepay/response.rb

@@ -0,0 +1,60 @@
+module SlidePay
+  class Response < String
+
+    attr_accessor :success, :custom, :operation, :endpoint, :timezone,
+                  :method, :obj, :id, :milliseconds, :data, :data_md5
+
+    def initialize(response_json=nil)
+      if response_json
+        replace response_json
+        parse_object_from_json
+      end
+    end
+
+    def parse_object_from_json
+      object = MultiJson.decode(self)
+
+      @success = object['success']
+      @custom = object['custom']
+      @operation = object['operation']
+      @endpoint = object['endpoint']
+      @timezone = object['timezone']
+      @method = object['method']
+      @obj = object['obj']
+      @id = object['id']
+      @milliseconds = object['milliseconds']
+      @data = object['data']
+      @data_md5 = object['data_md5']
+    end
+
+    def was_successful?
+      @success == true
+    end
+
+    # response metadata fields
+    def endpoint
+      "#{@endpoint}#{ENDPOINT_SUFFIX}"
+    end
+
+    # error fields
+    def error
+      if was_successful? == false
+        @data
+      else
+        nil
+      end
+    end
+
+    def error_code
+      if error
+        @data['error_code']
+      end
+    end
+
+    def error_text
+      if error
+        @data['error_text']
+      end
+    end
+  end
+end

data/lib/slidepay/util.rb

@@ -0,0 +1,5 @@
+module SlidePay
+  module Util
+
+  end
+end

data/lib/slidepay/version.rb

@@ -0,0 +1,3 @@
+module SlidePay
+  VERSION = "0.0.2"
+end

data/scenarios/example.rb

@@ -0,0 +1,32 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+$:.unshift(File.join(File.dirname(__FILE__), 'spec'))
+
+require 'multi_json'
+require 'slidepay'
+require 'spec_helper'
+
+include SlidePay
+
+SlidePay.configure(development: true)
+SlidePay.api_key = ENV["api_key"]
+
+# RestClient.proxy = "http://127.0.0.1:8888"
+
+# a = ApiKey.new
+# a["api_key_id"] = 17
+# a.is_new?
+# a.id_attribute
+# a.retrieve()
+
+p = Payment.new
+p["amount"] = 1.01
+p["method"] = "CreditCard"
+p["cc_number"] = "4111111111111111"
+p["cc_cvv2"] = "111"
+p["cc_billing_zip"] = "11111"
+p["cc_expiry_month"] = "10"
+p["cc_expiry_year"] = "14"
+r = p.process()
+p.refund()
+
+

data/slidepay.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'slidepay/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slidepay"
+  spec.version       = SlidePay::VERSION
+  spec.authors       = ["Matt Rothstein"]
+  spec.email         = ["matt@slidepay.com"]
+  spec.description   = "SlidePay makes it ridiculously easy to take swiped payments anywhere, on any device. Check out http://www.slidepay.com for more info."
+  spec.summary       = "SlidePay Ruby SDK"
+  spec.homepage      = "http://www.slidepay.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client"
+  spec.add_dependency "multi_json"
+  spec.add_dependency "json"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec", "~> 2.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "growl"
+end

data/spec/api_key_spec.rb

@@ -0,0 +1,38 @@
+require "slidepay"
+require "spec_helper"
+
+describe SlidePay::ApiKey do
+  it "should have an id_attribute" do
+    b = SlidePay::ApiKey.new()
+    expect(b.id_attribute).to eq("api_key_id")
+  end
+
+  it "should have a root url" do
+    b = SlidePay::ApiKey.new()
+    expect(b.url_root).to eq("api_key")
+  end
+
+  describe "url" do
+    it "should not append the object id if no id is set" do
+      b = SlidePay::ApiKey.new()
+      expect(b.url()).to eq("api_key")
+    end
+
+    it "should append the object id if set" do
+      b = SlidePay::ApiKey.new("api_key_id" => 2)
+      expect(b.url()).to eq("api_key/2")
+    end
+  end
+
+  describe "id" do
+    it "should return nil if the id is not set" do
+      b = SlidePay::ApiKey.new()
+      expect(b.id()).to eq(nil)
+    end
+
+    it "should return the id if it is present" do
+      b = SlidePay::ApiKey.new("api_key_id" => 2)
+      expect(b.id()).to eq(2)
+    end
+  end
+end

data/spec/api_resource_spec.rb

@@ -0,0 +1,227 @@
+require "slidepay"
+require "spec_helper"
+
+describe SlidePay::ApiResource do
+  before(:all) do
+    SlidePay.configure(development: true)
+  end
+
+  it "should be a Hash" do
+    r = SlidePay::ApiResource.new
+    expect(r).to be_a(Hash)
+  end
+
+  describe "initialize" do
+    it "should allow instantiation with no parameters" do
+      r = SlidePay::ApiResource.new
+      expect(r).to be_a(SlidePay::ApiResource)
+    end
+
+    it "should set api_key, token, and endpoint when they are present" do
+      resource = SlidePay::ApiResource.new(api_key: "TEST_API_KEY", token: "TEST_TOKEN", endpoint: "TEST_ENDPOINT")
+
+      expect(resource[:api_key]).to  eq(nil)
+      expect(resource[:token]).to  eq(nil)
+      expect(resource[:endpoint]).to  eq(nil)
+
+      expect(resource.api_key).to  eq("TEST_API_KEY")
+      expect(resource.token).to  eq("TEST_TOKEN")
+      expect(resource.endpoint).to  eq("TEST_ENDPOINT")
+    end
+
+    it "should values for keys other than :api_key, :token, or :endpoint into the instance" do
+      resource = SlidePay::ApiResource.new(api_key: "TEST_API_KEY", dog: "Fido", cat: "Dog")
+
+      expect(resource[:api_key]).to  eq(nil)
+      expect(resource[:dog]).to  eq("Fido")
+      expect(resource[:cat]).to  eq("Dog")
+    end
+  end
+
+  describe  "to_json" do
+    it "should return an empty object for a clean resource" do
+      r = SlidePay::ApiResource.new()
+      expect(r.to_json).to eq("{}")
+    end
+
+    it "should return a json representation of the hash contents" do
+      r = SlidePay::ApiResource.new(id: 1, name: "Dog the Bounty Hunter")
+      expect(r.to_json).to eq("{\"id\":1,\"name\":\"Dog the Bounty Hunter\"}" )
+    end
+  end
+
+  describe "is_new?" do
+    it "should return true if id_attribute is not set" do
+      resource = SlidePay::ApiResource.new(id: 1, name: "Dog the Bounty Hunter")
+      expect(resource.is_new?).to be_true
+    end
+
+    it "should return true if id_attribute is set but not present in the hash" do
+      resource = SlidePay::ApiResource.new(name: "Dog the Bounty Hunter")
+      resource.id_attribute = :id
+
+      expect(resource.is_new?).to be_true
+    end
+
+    it "should return false if id_attribute is set and present in the hash" do
+      resource = SlidePay::ApiResource.new(id: 1, name: "Dog the Bounty Hunter")
+      resource.id_attribute = :id
+
+      expect(resource.is_new?).to be_false
+    end
+  end
+
+  describe "id" do
+    it "should return nil if the id_attribute is not set" do
+      resource = SlidePay::ApiResource.new(id: 1, name: "Dog the Bounty Hunter")
+      expect(resource.id()).to eq(nil)
+    end
+
+    it "should return nil if the id_attribute is set but not present in the hash" do
+      resource = SlidePay::ApiResource.new(name: "Dog the Bounty Hunter")
+      resource.id_attribute = :id
+      expect(resource.id()).to eq(nil)
+    end
+
+    it "should return the value of the the id_attribute key inside the hash" do
+      resource = SlidePay::ApiResource.new(id: 1, name: "Dog the Bounty Hunter")
+      resource.id_attribute = :id
+      expect(resource.id()).to eq(1)
+    end
+  end
+
+  describe "url_root" do
+    context "when id_attribute is not set but is in the hash" do
+      resource = SlidePay::ApiResource.new(id: 1, name: "Dog the Bounty Hunter")
+      resource.url_root = "mullet_hero"
+
+      it "should return only the url_root" do
+        expect(resource.url()).to eq(resource.url_root)
+      end
+    end
+
+    context "when id_attribute is set but not in the hash" do
+      resource = SlidePay::ApiResource.new(name: "Dog the Bounty Hunter")
+      resource.id_attribute = :id
+      resource.url_root = "mullet_hero"
+
+      it "should return only the url_root" do
+        expect(resource.url()).to eq(resource.url_root)
+      end
+    end
+
+    context "when id_attribute is set and in the hash" do
+      resource = SlidePay::ApiResource.new(id: 1, name: "Dog the Bounty Hunter")
+      resource.id_attribute = :id
+      resource.url_root = "mullet_hero"
+
+      it "should return a specific path like :url_root/:id_attribute" do
+        expect(resource.url()).to eq("#{resource.url_root}/#{resource[resource.id_attribute]}")
+      end
+    end
+  end
+
+  describe "retrieve" do
+    it "should raise an exception if the resource has no id" do
+      resource = SlidePay::ApiResource.new(name: "Dog the Bounty Hunter")
+      expect { resource.retrieve() }.to raise_error
+    end
+
+    it "should make a get request if the resource has an id" do
+      resource = SlidePay::ApiResource.new(id: 1)
+      resource.url_root = "person"
+      resource.id_attribute = :id
+
+      SlidePay.should_receive(:get).with(path: "person/1", token: nil, api_key: nil, endpoint: nil).and_return(a_response_object)
+      resource.retrieve()
+    end
+
+    it "should have the contents of the response when call is successful" do
+      resource = SlidePay::ApiResource.new({"id" =>  1})
+      resource.url_root = "person"
+      resource.id_attribute = "id"
+
+      SlidePay.should_receive(:get).with(path: "person/1", token: nil, api_key: nil, endpoint: nil).and_return(a_response_object)
+      resource.retrieve()
+
+      expect(resource["id"]).to eq("1")
+      expect(resource["name"]).to eq("Dog the Bounty Hunter")
+    end
+  end
+
+  describe "save" do
+    before(:all) do
+      SlidePay.stub(:get) { a_response_object }
+      SlidePay.stub(:post) { a_response_object }
+      SlidePay.stub(:put) { a_response_object }
+    end
+
+    context "when the resource is new (has no id)" do
+      it "should make a post request if the resource has no id" do
+        resource = SlidePay::ApiResource.new(name: "Dog the Bounty Hunter")
+        resource.url_root = "person"
+        resource.id_attribute = "id"
+        SlidePay.should_receive(:post).with(path: "person", token: nil, api_key: nil, endpoint: nil, data: resource.to_json).and_return(a_response_object)
+        resource.save()
+      end
+
+      it "should populate the object with the returned values on a successful response" do
+        resource = SlidePay::ApiResource.new(name: "Dog the Bounty Hunter")
+        SlidePay.should_receive(:post).and_return(a_response_object)
+        resource.save()
+
+        expect(resource["id"]).to eq("1")
+        expect(resource["name"]).to eq("Dog the Bounty Hunter")
+      end
+    end
+
+    context "when the resource is not new (has an id)" do
+      it "should make a put request if the resource has an id" do
+        resource = SlidePay::ApiResource.new(id: 1, name: "---this should be replaced--")
+        resource.url_root = "person"
+        resource.id_attribute = :id
+
+        SlidePay.should_receive(:put).with(path: "person/1", token: nil, api_key: nil, endpoint: nil, data: resource.to_json).and_return(a_response_object)
+        resource.save()
+      end
+
+      it "should populate the object with the returned values on a successful response" do
+        resource = SlidePay::ApiResource.new(id: 1, name: "---this should be replaced--")
+        resource.url_root = "person"
+        resource.id_attribute = :id
+
+        SlidePay.should_receive(:put).and_return(a_response_object)
+        resource.save()
+
+        expect(resource["id"]).to eq("1")
+        expect(resource["name"]).to eq("Dog the Bounty Hunter")
+      end
+    end
+  end
+
+  describe "destroy" do
+    it "should raise an error if the resource is new (has no id)" do
+      resource = SlidePay::ApiResource.new
+      expect { resource.destroy() }.to raise_error
+    end
+
+    it "should make a delete request and return true" do
+      resource = SlidePay::ApiResource.new(id: 1, name: "Dog the Bounty Hunter")
+      resource.id_attribute = :id
+      resource.url_root = "person"
+
+      SlidePay.should_receive(:delete).and_return(a_response_object(successful_deletion_response))
+      expect(resource.destroy()).to be_true
+    end
+
+    it "should delete the id_attribute key/value pair from the hash on deletion" do
+      resource = SlidePay::ApiResource.new(id: 1, name: "Dog the Bounty Hunter")
+      resource.id_attribute = :id
+      resource.url_root = "person"
+
+      SlidePay.should_receive(:delete).and_return(a_response_object(successful_deletion_response))
+      expect(resource.destroy()).to be_true
+      expect(resource[:id]).to be_nil
+    end
+  end
+end