slidepay 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea9149688f04b38ba2d7253f8805ebe167a518b9
-  data.tar.gz: 925a135adacc97d7f5c25d653a10e4b08da01996
+  metadata.gz: 83778705a23a1f6a5e99703eb71378d771ddf692
+  data.tar.gz: a17a2085f2568a65c4e8048714b4917618e06c93
 SHA512:
-  metadata.gz: 4c50c362f7d73afcd7da67a06a423affc13b1a4701041057af683a4b3c159e097aeaa91b3642fffb1871addd978b838fe7502845188fe6cd206fa94972f8d61f
-  data.tar.gz: 37ea01471930e0a3691a3904c8b17a21dc8584e0e2f0025841088f4c80e1d3a5fdbfa78a3634351d91d32173eb8d1c195d9d6fd3468c5cfd11478d300a5164a3
+  metadata.gz: 7165aad1cdda93fd228367c5d823313270d7f3f6c457a17557cfbacb0411c859e24bd9c15cb4403dde6f912671d9b07057bb93e0df83c9c6f317c80ecb939e26
+  data.tar.gz: 927b27f371a156d55a7e428ae31ff8fe1a87226796e2e95f124604251619e68c941518fa727159687431176ebef43b48676dfbfda37000694db5f7337c0ffabb

data/README.md

@@ -2,7 +2,7 @@
 
 # Slidepay Ruby Sdk
 
-[![Build Status](https://travis-ci.org/SlidePay/slidepay-ruby-sdk.png)](https://travis-ci.org/SlidePay/slidepay-ruby-sdk) [![Code Climate](https://codeclimate.com/repos/5236cb7013d6371e46004010/badges/f963bebb1565c5419c78/gpa.png)](https://codeclimate.com/repos/5236cb7013d6371e46004010/feed)
+[![Gem Version](https://badge.fury.io/rb/slidepay.png)](http://badge.fury.io/rb/slidepay) [![Build Status](https://travis-ci.org/SlidePay/slidepay-ruby-sdk.png)](https://travis-ci.org/SlidePay/slidepay-ruby-sdk) [![Code Climate](https://codeclimate.com/repos/5236cb7013d6371e46004010/badges/f963bebb1565c5419c78/gpa.png)](https://codeclimate.com/repos/5236cb7013d6371e46004010/feed)
 
 First version of the SlidePay Ruby SDK
 
@@ -31,7 +31,7 @@ Check out our [main documentation](https://getcube.atlassian.net/wiki/display/CD
 Requests can be made three ways:
 
 1. Using the SlidePay request methods directly with the desired API url and relevant request JSON
-2. [Coming Soon] Using an instance of the SlidePay::Client class to save an ApiResource, such as a payment, order, or item
+2. Using an instance of the SlidePay::Client class to save an ApiResource, such as a payment, bank_account, or api_key
 3. Using an instance of a SlidePay::ApiResource class, such as SlidePay::ApiKey or SlidePay::Payment
 
 ## Authentication

data/lib/slidepay/client.rb

@@ -40,12 +40,14 @@ module SlidePay
 
     # Base Request Methods
     def get(request_params)
+      options = {}
       if request_params.is_a? String
-        SlidePay.get(path: request_params, api_key: @api_key, token: @token, endpoint: @endpoint)
+        options = { :path => request_params, :api_key => @api_key, :token => @token, :endpoint => @endpoint }
       else
-        request_params.merge! api_key: @api_key, token: @token, endpoint: @endpoint
-        SlidePay.get(request_params)
+        options = request_params.merge! api_key: @api_key, token: @token, endpoint: @endpoint
       end
+
+      SlidePay.get(options)
     end
 
     def put(request_params)
@@ -59,12 +61,13 @@ module SlidePay
     end
 
     def delete(request_params)
+      options = {}
       if request_params.is_a? String
-        SlidePay.delete(path: request_params, api_key: @api_key, token: @token, endpoint: @endpoint)
+        options = { :path => request_params, :api_key => @api_key, :token => @token, :endpoint => @endpoint }
       else
-        request_params.merge! api_key: @api_key, token: @token, endpoint: @endpoint
-        SlidePay.delete(request_params)
+        options = request_params.merge! api_key: @api_key, token: @token, endpoint: @endpoint
       end
+      SlidePay.delete(options)
     end
 
 
@@ -94,6 +97,5 @@ module SlidePay
     def destroy(resource)
       resource.destroy(api_key: @api_key, token: @token, endpoint: @endpoint)
     end
-
   end
 end

data/lib/slidepay/resources/api_resource.rb

@@ -2,6 +2,10 @@ module SlidePay
   class ApiResource < Hash
     attr_accessor :url_root, :id_attribute, :token, :api_key, :endpoint
 
+    # These MUST be declared in the inheriting classes
+    URL_ROOT = ""
+    ID_ATTRIBUTE = ""
+
     def initialize(values_hash={})
       if values_hash[:url_root]
         @url_root = values_hash[:url_root]
@@ -113,5 +117,84 @@ module SlidePay
         false
       end
     end
+
+    class << self
+      def find_where(search_params, token=nil, api_key=nil, endpoint=nil)
+        sfa = []
+        search_params.each_pair do |k,v|
+          sfa.push(field: k, condition: "equals", value: v)
+        end
+
+        search_results = []
+        response = SlidePay.put(path: self::URL_ROOT, data: sfa.to_json, token: token, api_key: api_key, endpoint: endpoint)
+        if response.was_successful? and response.data != nil
+          data = response.data
+          data.each do |resource_hash|
+            search_results.push self.new(resource_hash)
+          end
+        end
+
+        search_results
+      end
+
+      def find_between(start_params, end_params, token=nil, api_key=nil, endpoint=nil)
+        sfa = []
+        start_params.each_pair do |k,v|
+          sfa.push(field: k, condition: "greater_than", value: v)
+        end
+
+        end_params.each_pair do |k,v|
+          sfa.push(field: k, condition: "less_than", value: v)
+        end
+
+        search_results = []
+        response = SlidePay.put(path: self::URL_ROOT, data: sfa.to_json, token: token, api_key: api_key, endpoint: endpoint)
+        if response.was_successful? and response.data != nil
+          data = response.data
+          data.each do |resource_hash|
+            search_results.push self.new(resource_hash)
+          end
+        end
+
+        search_results
+      end
+
+      def find_greater_than(search_params, token=nil, api_key=nil, endpoint=nil)
+        sfa = []
+        search_params.each_pair do |k,v|
+          sfa.push(field: k, condition: "greater_than", value: v)
+        end
+
+        search_results = []
+        response = SlidePay.put(path: self::URL_ROOT, data: sfa.to_json, token: token, api_key: api_key, endpoint: endpoint)
+        if response.was_successful? and response.data != nil
+          data = response.data
+          data.each do |resource_hash|
+            search_results.push self.new(resource_hash)
+          end
+        end
+
+        search_results
+      end
+
+      def find_less_than(search_params, token=nil, api_key=nil, endpoint=nil)
+        sfa = []
+        search_params.each_pair do |k,v|
+          sfa.push(field: k, condition: "less_than", value: v)
+        end
+
+        search_results = []
+        response = SlidePay.put(path: self::URL_ROOT, data: sfa.to_json, token: token, api_key: api_key, endpoint: endpoint)
+        if response.was_successful? and response.data != nil
+          data = response.data
+          data.each do |resource_hash|
+            search_results.push self.new(resource_hash)
+          end
+        end
+
+        search_results
+      end
+    end
+
   end
 end

data/lib/slidepay/resources/payment.rb

@@ -1,5 +1,8 @@
 module SlidePay
   class Payment < ApiResource
+    URL_ROOT = "payment"
+    ID_ATTRIBUTE = "payment_id"
+
     def initialize(values_hash={})
       @id_attribute = "payment_id"
       @url_root = "payment"

data/lib/slidepay/version.rb

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

data/scenarios/payment_find_where_id.rb

@@ -0,0 +1,40 @@
+$:.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"
+
+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()
+
+if r
+  puts "Payment created with id: #{p.id}"
+
+  # Find the payment that was just created.
+  payments_found = Payment.find_where(payment_id: p.id)
+
+  puts "Payments found: #{payments_found.length}"
+  puts "============================================="
+  payments_found.each do |payment|
+    puts "#{payment.id} - #{payment["amount"]}"
+  end
+
+
+else
+  puts "Payment failed. "
+end

data/scenarios/payment_find_where_under_review.rb

@@ -0,0 +1,26 @@
+$:.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"
+
+# Find any payments in this company that are under review
+payments_found = Payment.find_where(under_review: 1)
+
+if payments_found.count > 0
+  puts "Payments found: #{payments_found.length}"
+  puts "============================================="
+  payments_found.each do |payment|
+    puts "#{payment.id} - #{payment["amount"]}"
+  end
+else
+  puts "No payments found to be under review. Yay(?)"
+end

data/spec/api_resource_spec.rb

@@ -224,4 +224,99 @@ describe SlidePay::ApiResource do
       expect(resource[:id]).to be_nil
     end
   end
+
+  describe "search" do
+    before(:all) do
+      SlidePay.stub(:put) { a_response_object(successful_array_response) }
+    end
+
+    it "should be represented by several instance methods" do
+      public_methods = SlidePay::ApiResource.public_methods
+
+      expect(public_methods.include?(:find_where)).to be_true
+      expect(public_methods.include?(:find_greater_than)).to be_true
+      expect(public_methods.include?(:find_less_than)).to be_true
+      expect(public_methods.include?(:find_between)).to be_true
+    end
+
+    describe "find_where" do
+      it "should raise an error if no parameters are supplied" do
+        expect{ SlidePay::ApiResource.find_where }.to raise_error
+      end
+
+      it "should accept a hash" do
+        expect { SlidePay::ApiResource.find_where(created: "12/13/2013") }.not_to raise_error
+      end
+
+      it "should return an array of resources" do
+        expect(SlidePay::ApiResource.find_where(created: "12/13/2013")).to be_a(Array)
+      end
+
+      it "should make a put request" do
+        SlidePay.should_receive(:put).and_return(a_response_object(successful_array_response))
+        SlidePay::ApiResource.find_where(created: "12/13/2013")
+      end
+    end
+
+    describe "find_greater_than" do
+      it "should raise an error if no parameters are supplied" do
+        expect{ SlidePay::ApiResource.find_greater_than }.to raise_error
+      end
+
+      it "should accept a hash" do
+        expect { SlidePay::ApiResource.find_greater_than(created: "12/13/2013") }.not_to raise_error
+      end
+
+      it "should return an array of resources" do
+        expect(SlidePay::ApiResource.find_greater_than(created: "12/13/2013")).to be_a(Array)
+      end
+
+      it "should make a put request" do
+        SlidePay.should_receive(:put).and_return(a_response_object(successful_array_response))
+        SlidePay::ApiResource.find_greater_than(created: "12/13/2013")
+      end
+    end
+
+    describe "find_less_than" do
+      it "should raise an error if no parameters are supplied" do
+        expect{ SlidePay::ApiResource.find_less_than }.to raise_error
+      end
+
+      it "should accept a hash" do
+        expect { SlidePay::ApiResource.find_less_than(created: "12/13/2013") }.not_to raise_error
+      end
+
+      it "should return an array of resources" do
+        expect(SlidePay::ApiResource.find_less_than(created: "12/13/2013")).to be_a(Array)
+      end
+
+      it "should make a put request" do
+        SlidePay.should_receive(:put).and_return(a_response_object(successful_array_response))
+        SlidePay::ApiResource.find_less_than(created: "12/13/2013")
+      end
+    end
+
+    describe "find_between" do
+      it "should raise an error if no parameters are supplied" do
+        expect{ SlidePay::ApiResource.find_between }.to raise_error
+      end
+
+      it "should return an array of resources" do
+        SlidePay.should_receive(:put).and_return(a_response_object(successful_array_response))
+
+        expect(SlidePay::ApiResource.find_between(
+          { :created => "12/13/2013" },
+          { :created => "12/14/2013" }
+        )).to be_a(Array)
+      end
+
+      it "should make a put request" do
+        SlidePay.should_receive(:put).and_return(a_response_object(successful_array_response))
+        expect(SlidePay::ApiResource.find_between(
+          { :created => "12/13/2013" },
+          { :created => "12/14/2013" }
+        )).to be_a(Array)
+      end
+    end
+  end
 end

data/spec/payment_spec.rb

@@ -2,6 +2,16 @@ require "slidepay"
 require "spec_helper"
 
 describe SlidePay::Payment do
+  describe "class constants" do
+    it "should include an id_attribute" do
+      expect(SlidePay::Payment::ID_ATTRIBUTE).to eq("payment_id")
+    end
+
+    it "should include a root url" do
+      expect(SlidePay::Payment::URL_ROOT).to eq("payment")
+    end
+  end
+
   it "should have an id_attribute" do
     p = SlidePay::Payment.new()
     expect(p.id_attribute).to eq("payment_id")
@@ -87,4 +97,53 @@ describe SlidePay::Payment do
       expect(p.refund()).to eq(true)
     end
   end
+
+  describe "class methods" do
+    describe "search" do
+      it "should be represented by several instance methods" do
+        public_methods = SlidePay::Payment.public_methods
+
+        expect(public_methods.include?(:find_where)).to be_true
+        expect(public_methods.include?(:find_greater_than)).to be_true
+        expect(public_methods.include?(:find_less_than)).to be_true
+        expect(public_methods.include?(:find_between)).to be_true
+      end
+
+      describe "find_where" do
+        it "should make a put request to /payment" do
+          SlidePay.should_receive(:put)
+            .with(path: "payment", data: payment_where_sfa.to_json, token: nil, api_key: nil, endpoint: nil)
+            .and_return(a_response_object(payment_search_response))
+          SlidePay::Payment.find_where(created: "12/13/2013")
+        end
+      end
+
+      describe "find_less_than" do
+        it "should make a put request to /payment" do
+          SlidePay.should_receive(:put)
+            .with(path: "payment", data: payment_less_than_sfa.to_json, token: nil, api_key: nil, endpoint: nil)
+            .and_return(a_response_object(payment_search_response))
+          SlidePay::Payment.find_less_than(created: "10/08/2012")
+        end
+      end
+
+      describe "find_greater_than" do
+        it "should make a put request to /payment" do
+          SlidePay.should_receive(:put)
+            .with(path: "payment", data: payment_greater_than_sfa.to_json, token: nil, api_key: nil, endpoint: nil)
+            .and_return(a_response_object(payment_search_response))
+          SlidePay::Payment.find_greater_than(created: "10/08/2013 23:28:40")
+        end
+      end
+
+      describe "find_between" do
+        it "should make a put request to /payment" do
+          SlidePay.should_receive(:put)
+            .with(path: "payment", data: payment_between_sfa.to_json, token: nil, api_key: nil, endpoint: nil)
+            .and_return(a_response_object(payment_search_response))
+          SlidePay::Payment.find_between({:created => "10/08/2013 23:28"}, {:created => "10/08/2013 23:28:40"})
+        end
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -254,6 +254,115 @@ def successful_array_response
   eos
 end
 
+def payment_where_sfa
+  [{ :field => "created", :condition => "equals", :value => "12/13/2013" }]
+end
+
+def payment_greater_than_sfa
+  [{ field: "created", condition: "greater_than", value: "10/08/2013 23:28:40"}]
+end
+
+def payment_less_than_sfa
+  [{ field: "created", condition: "less_than", value: "10/08/2012"}]
+end
+
+def payment_between_sfa
+  [{ field: "created", condition: "greater_than", value: "10/08/2013 23:28"},
+   { field: "created", condition: "less_than", value: "10/08/2013 23:28:40"}]
+end
+
+def payment_search_response
+  <<-eos
+  {
+    "success": true,
+    "custom": null,
+    "operation": "PUT search payment",
+    "endpoint": "https://dev.getcube.com:65532",
+    "timezone": "",
+    "method": "put",
+    "obj": "payment",
+    "id": 0,
+    "milliseconds": "15.62",
+    "data": [
+      {
+        "payment_id": 10923,
+        "order_master_id": 4133,
+        "company_id": 18,
+        "location_id": 14,
+        "customer_id": 0,
+        "user_master_id": 32,
+        "auto_capture": 1,
+        "device_type": "",
+        "method": "CreditCard",
+        "method_other": "",
+        "stored_payment_guid": "6f9a90c4-69c3-41cc-8dcd-299a0b6915c3",
+        "cc_type": "Visa",
+        "cc_present": 0,
+        "cc_number": "4111111111111111",
+        "cc_expiry_month": "11",
+        "cc_expiry_year": "11",
+        "cc_name_on_card": "",
+        "cc_address_1": "",
+        "cc_address_2": "",
+        "cc_address_3": "",
+        "cc_city": "",
+        "cc_state": "",
+        "cc_billing_zip": "11111",
+        "cc_country": "",
+        "cc_track1data": "",
+        "cc_track2data": "",
+        "cc_cvv2": "",
+        "cc_redacted_number": "************1111",
+        "encryption_vendor": "",
+        "encryption_ksn": "",
+        "encryption_device_serial": "",
+        "amount": 14.01,
+        "tip_amount": 0.00,
+        "is_refund": null,
+        "refund_payment_id": null,
+        "is_chargeback": 0,
+        "under_review": 0,
+        "notes": "Goods or Services",
+        "signature_cloud_object_id": null,
+        "provider": "ipcommerce-cube-vantiv",
+        "provider_payment_token": "",
+        "provider_transaction_token": "DummyTransaction",
+        "provider_is_approved": "true",
+        "provider_status_code": "00",
+        "provider_status_message": "Transaction Approved",
+        "provider_transaction_state": "Authorized",
+        "provider_approval_code": "000000",
+        "provider_capture_state": "DummyTransaction",
+        "provider_capture_status_message": "",
+        "settlement_transaction_token": "",
+        "provider_fee_amount": 0.00,
+        "vendor_id": "cube",
+        "vendor_markup_percent": 0.00,
+        "vendor_markup_pertrans": 0.00,
+        "fee_percentage": 3.50,
+        "fee_percentage_amount": 0.50,
+        "fee_per_transaction": 0.00,
+        "fee_interchange": null,
+        "fee_total": 0.50,
+        "ip_address": "50.152.207.105",
+        "latitude": "38.0000",
+        "longitude": "-97.0000",
+        "country": "US",
+        "distance_from_location": 1368.70,
+        "processor_time_ms": 0.00,
+        "total_time_ms": null,
+        "capture_requested": null,
+        "capture_confirmed": null,
+        "created": "2013-10-08T23:29:01",
+        "last_update": "2013-10-08T23:29:01"
+      }
+    ],
+    "data_md5": "96F66EF31C54F3D0F63F8D52BFC1B3A4"
+  }
+  eos
+end
+
+
 def bank_account_array_response
   <<-eos
   {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slidepay
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Matt Rothstein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-25 00:00:00.000000000 Z
+date: 2013-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -165,6 +165,8 @@ files:
 - lib/slidepay/util.rb
 - lib/slidepay/version.rb
 - scenarios/example.rb
+- scenarios/payment_find_where_id.rb
+- scenarios/payment_find_where_under_review.rb
 - slidepay.gemspec
 - spec/api_key_spec.rb
 - spec/api_resource_spec.rb