slidepay 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd62eeffb82c24dd9a5b13c668a23360ef24518c
-  data.tar.gz: f923dc072e19a532cfa02fbc895624f0875ee314
+  metadata.gz: 0717f747633f7aa532d21e58b8867ac449c4bcfe
+  data.tar.gz: c1a4afcf7d8c27775bd2e91b5288dcd27eec5141
 SHA512:
-  metadata.gz: fc7c0e792d1345f7a27386e6cf723a1fc14beb1913a7a59da43ae07dfaace5f21b51a61a0ae9926ac58b287cba041de1816c1c88d363dfc13769170ac8f9b26b
-  data.tar.gz: 1d853ef6581545a605a0b31f861b2001fa05599e108d296216ef889f306767e5b78a48773f1964cc775c95836614b4af5adaddc32b92e85bd516dd536628f0e9
+  metadata.gz: 6066b6d41e7909b954fc490a1d94927e8691c372f6ed331298a57ae0423c0db87be3da2fd401dfa7d0f649f606fb2693017c6e3f50f765542f19331dfd9f2b87
+  data.tar.gz: 3b89bd21f9ba4de0c611d89dd533ad65735382ccdc34b5f1ad22526d5c914bb14a4c0b503a916afb04a71f7680ba061305fcfaeb6d5fad2af594fb523d4ac4a2

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)
+[![Build Status](https://travis-ci.org/SlidePay/slidepay-ruby-sdk.png)](https://travis-ci.org/SlidePay/slidepay-ruby-sdk) [![Code Climate](https://codeclimate.com/github/SlidePay/slidepay-ruby-sdk.png)](https://codeclimate.com/github/SlidePay/slidepay-ruby-sdk)
 
 First version of the SlidePay Ruby SDK
 
@@ -59,7 +59,7 @@ SlidePay.authenticate(email, password)
 You can retrieve a token for use in any context with the retrieve_token method, which is similar to SlidePay.authenticate except that it returns the token string and does not set a global token value.
 
 ```ruby
-SlidePay.authenticate(email, password)
+SlidePay.retrieve_token(email, password)
 ```
 
 These fields can also be used on an instance or per-request level by either passing them into the SlidePay module request methods as a field in a hash, or by assigning instance variables on a SlidePay::Client.
@@ -74,13 +74,101 @@ SlidePay.get(path: "payment/#{payment_id}", api_key: "MY_API_KEY")
 
 ## Resources
 
-SlidePay::ApiResources are classes that encapsulate RESTful API resources. API interaction relative to these resources is handled by the following descriptive methods:
+The Ruby SDK provides explicit interfaces to the following SlidePay resources:
+- api_key through the [ApiKey](https://github.com/SlidePay/slidepay-ruby-sdk/blob/master/lib/slidepay/resources/api_key.rb) class
+- bank_account through the [BankAccount](https://github.com/SlidePay/slidepay-ruby-sdk/blob/master/lib/slidepay/resources/bank_account.rb) class
+- payment through the [Payment](https://github.com/SlidePay/slidepay-ruby-sdk/blob/master/lib/slidepay/resources/payment.rb) class
+- user_master through the [UserMaster](https://github.com/SlidePay/slidepay-ruby-sdk/blob/master/lib/slidepay/resources/user_master.rb) class
+- customer through the [Customer](https://github.com/SlidePay/slidepay-ruby-sdk/blob/master/lib/slidepay/resources/customer.rb) class
+
+All of the above resource classes inherit class- and instance-level functionality from [SlidePay::ApiResource](https://github.com/SlidePay/slidepay-ruby-sdk/blob/master/lib/slidepay/resources/api_resource.rb).
+
+As a result, each resource class provides common searching and CRUD functionality.
+
+## Search
+
+Each ApiResource offers several class-level search methods:
+
+- find(search_filter_array)
+- find_where(value_hash)
+- find_between(start_value_hash, end_value_hash)
+- find_greater_than(value_hash)
+- find_less_than(value_hash)
+
+Each of these methods will return an array of zero or more instances of the ApiResource class.
+
+### find(search_filter_array)
+
+```find``` is a flexible interface for placing restrictions on a search. Search parameters must be supplied in the form of a [search filter array](https://getcube.atlassian.net/wiki/display/CDP/search_filter+and+search_filter_array). To supply them, pass an array of search filter Hashes as the first parameter.
+
+```ruby
+
+# Find users whose first name contains "at"
+users = SlidePay::UserMaster.find(field: "first_name", condition: "contains", value: "at")
+
+# Find all users whose first name is "Matt"
+users = SlidePay::UserMaster.find(field: "first_name", condition: "equals", value: "Matt")
+
+```
+
+### find_where(value_hash)
+
+```find_where``` allows you to specify equality constraints in your search. For instance, the following example is equivalent to the second ```find``` example above.
+
+```ruby
+
+# Find all users whose first name is "Matt"
+users = SlidePay::UserMaster.find_where(first_name: "Matt")
+
+```
+
+### find_greater_than(value_hash) and find_less_than(value_hash)
+
+```find_greater_than``` and ```find_less_than``` allow searching for resources with values greater than or less than what is provided in the hash.
+
+```ruby
+
+# Find all payments greater than $200.00
+payments = SlidePay::Payment.find_greater_than(amount: 200.00)
+
+# Find all payments less than $10.00
+payments = SlidePay::Payment.find_less_than(amount: 10.00)
+
+# Find all users created after 10/12/2013 at 12:00 AM
+users = SlidePay::UserMaster.find_greater_than(created: "10/12/2013")
+
+# Find all users created before 10/05/2013 at 12:00 AM
+users = SlidePay::UserMaster.find_less_than(created: "10/05/2013")
+
+```
+
+### find_between(start_value_hash, end_value_hash)
+
+```find_between``` takes two value hashes as arguments to combine the functionality of find_greater_than and find_less_than.
+
+```ruby
+
+# Find all payments made between 10/05/2013 and 10/12/2013
+start_values = { created: "10/05/2013" }
+end_values = { created: "10/12/2013" }
+payments = SlidePay::Payment.find_between(start_values, end_values)
+
+# Find all payments between $3.00 and $10.00
+start_values = { amount: 3.00 }
+end_values = { amount: 10.00 }
+payments = SlidePay::Payment.find_between(start_values, end_values)
+
+```
+
+## CRUD (Create, Read, Update, Delete)
+
+Each ApiResource class provides RESTful CRUD functionality through the following instance methods:
 
 - ```save ```
 - ```destroy ```
 - ```retrieve ```
 
-The ```save``` method can handle both creation, via POST, and updating, via PUT, and determines which verb is appropriate by the ```ApiResource.is_new?``` method, which checks for the presence of an id in the resource.
+The ```save``` method can handle both creation via POST, and updating via PUT. It determines which verb is appropriate by the ```ApiResource.is_new?``` method, which checks for data in the appropriate *_id field of the resource.
 
 ## Payments
 
@@ -105,13 +193,27 @@ SlidePay.post(path: 'payment/refund/#{payment_id}')
 
 ## Testing
 
+### Basics
+
 Test are in the spec directory, and can be run from the root of the repository:
 
 ```bash
 $ rspec spec
 ```
 
-Some tests will require that you have an active SlidePay account on the development server, and that you supply those credentials in an ```environment.rb``` file in the root of this repository.
+### Automatic Testing
+
+There is also a Guardfile in the root directory of the library that will help test changes automatically. If you intend to modify this code, we highly recommend you configure [Guard](https://github.com/guard/guard) on your system to make use of this.
+
+Once installed, run the Guard monitor from the root of the repository:
+
+```bash
+$ guard
+```
+
+### Scenarios Requiring Account Information
+
+Some tests, the ones in the scenarios directory, will require that you have an active SlidePay account on the development server, and that you supply those credentials in an ```environment.rb``` file in the root of this repository.
 
 Your populated environment.rb should look something like this:
 
@@ -124,8 +226,6 @@ ENV["api_key"]    = "super-secret-api-key-that-you-never-share"
 
 ## Notes
 
-The SlidePay::Client class is largely untested and likely non-functional.
-
 Though this document rarely mentions authentication in most examples following the section above dedicated to it, an api_key or token, and an endpoint, may be supplied to any object or module that can perform an API request. This flexibility allows for interacting with a single instance of a single ApiResource class without having to use the SlidePay module methods directly, or having to use an instance of the SlidePay::Client class. It also accommodates those developers who may wish to authenticate many SlidePay accounts within a single thread, such as inside a request context of a Rails application, or in a scheduled task, without having to repeatedly set the SlidePay.token or SlidePay.api_key global values.
 
 ## License

data/lib/slidepay/resources/api_resource.rb

@@ -119,17 +119,23 @@ module SlidePay
     end
 
     class << self
-      def retrieve(token=nil, api_key=nil, endpoint=nil)
-        response = SlidePay.get(path: self::URL_ROOT, token: token, api_key: api_key, endpoint: endpoint)
-
-        results = []
+      def api_resource_array_from_response(response)
+        resources_array = []
         if response.was_successful? and response.data != nil
           data = response.data
           data.each do |resource_hash|
-            results.push self.new(resource_hash)
+            resources_array.push self.new(resource_hash)
           end
         end
-        results
+
+        resources_array
+      end
+
+
+      def retrieve(token=nil, api_key=nil, endpoint=nil)
+        response = SlidePay.get(path: self::URL_ROOT, token: token, api_key: api_key, endpoint: endpoint)
+
+        return api_resource_array_from_response(response)
       end
 
       def find(search_params, token=nil, api_key=nil, endpoint=nil)
@@ -141,17 +147,9 @@ module SlidePay
         elsif not search_params.is_a? Array
           raise Exception.new("Invalid or no search filter supplied.")
         end
-
-        search_results = []
         response = SlidePay.put(path: self::URL_ROOT, data: search_params.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
+        return api_resource_array_from_response(response)
       end
 
       def find_where(search_params, token=nil, api_key=nil, endpoint=nil)
@@ -160,16 +158,7 @@ module SlidePay
           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
+        return find(sfa, token, api_key, endpoint)
       end
 
       def find_between(start_params, end_params, token=nil, api_key=nil, endpoint=nil)
@@ -182,16 +171,7 @@ module SlidePay
           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
+        return find(sfa, token, api_key, endpoint)
       end
 
       def find_greater_than(search_params, token=nil, api_key=nil, endpoint=nil)
@@ -200,16 +180,7 @@ module SlidePay
           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
+        return find(sfa, token, api_key, endpoint)
       end
 
       def find_less_than(search_params, token=nil, api_key=nil, endpoint=nil)
@@ -218,16 +189,7 @@ module SlidePay
           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
+        return find(sfa, token, api_key, endpoint)
       end
     end
 

data/lib/slidepay/resources/customer.rb

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

data/lib/slidepay/version.rb

@@ -1,3 +1,3 @@
 module SlidePay
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slidepay
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Matt Rothstein
@@ -160,6 +160,7 @@ files:
 - lib/slidepay/resources/api_key.rb
 - lib/slidepay/resources/api_resource.rb
 - lib/slidepay/resources/bank_account.rb
+- lib/slidepay/resources/customer.rb
 - lib/slidepay/resources/payment.rb
 - lib/slidepay/resources/user_master.rb
 - lib/slidepay/response.rb