yellow-sdk 0.0.3 → 0.0.4

data/README.md

@@ -2,28 +2,26 @@ Yellow Python SDK
 =====================
 This is the Yellow Ruby SDK. This simple SDK contains couple of Ruby methods that makes it easy to integrate with the Yellow API. To get started just:
 ```
-pip install yellow-sdk-python
+gem install yellow-sdk
 ```
 
 Examples
 ---------
 ```
-import json
-import yellow
+require 'yellow-sdk'
 
+# pass your API key and secret respectively
+yellow = Yellow::Client.new("Eo2XE5SrHcJVdqK9uIDU", "73jnZflRHpGReqFxzwF_JtynRNmZXoQspPaxTtsy")
 
-# You can get your api key/secret from your merchant dashboard.
+options = { 
+           :base_ccy => 'USD',
+           :base_price => '20',
+           :callback => "https://anycallback.com"
+          }
 
-api_key = "YOUR_API_KEY"            # store it in environment variable for better security
-api_secret = "YOUR_API_SECRET"      # store it in environment variable for better security
-base_ccy = "USD"                    # Required: A 3-letter currency code
-base_price = "0.05"                 # Required: The invoice price in the above currency
-callback = "https://example.com"    # Optional: URL for Yellow to POST to as a callback
+invoice = yellow.create_invoice(options)
 
-created_invoice = yellow.create_invoice(api_key, api_secret, base_ccy, base_price, callback)
-
-# Print the result beautifully!
-print json.dumps(created_invoice.json(), sort_keys=True, indent=4)
+puts invoice
 ```
 You should see something similar to the following in your terminal:
 ```
@@ -45,19 +43,17 @@ You should see something similar to the following in your terminal:
 }
 
 ```
-To query an invoice that you created, just pass in the `invoice_id` to the `query_invoice` function:
+To query an invoice that you created, just pass in the `invoice_id` to the `query_invoice` method:
 ```
-invoice_id = "..." # invoice ID you received when you created the invoice.
-invoice = yellow.query_invoice(api_key, api_secret, invoice_id)
-print json.dumps(invoice.json(), sort_keys=True, indent=4)
+invoice = yellow.query_invoice("6dd264975861fddbfs4404ed995f1ca4")
+puts invoice
 ```
 You should see exactly the same returned data you got from `create_invoice` above!
 
 Verifying Yellow POST requests
 ---------------------------
-To verify that the request you just receive really is from us, we created a helper function that checks the signature of the request. Just pass in your api_secret, the callback URL you passed when you created the invoice, and the request object.
-
-This function will return True if the signature matches (verified), or False if it doesn't match (not verified).
+To verify that the request you just receive really is from us, we created a helper method that checks the signature of the request. This method will return true if the signature matches (verified), or false if it doesn't match (not verified).
 ```
-is_verified = yellow.verify_ipn(api_secret, host_url, request)
+is_verified = yellow.verify_ipn(host_url, request_signature, request_nonce, request_body)
 ```
+Since this method only works in the context of a web app, check the [full demo code](https://github.com/YellowPay/yellowdemo-ruby) for more info on how to use it.

data/lib/yellow-sdk.rb

@@ -3,4 +3,4 @@ require 'json'
 require 'uri'
 require 'net/http'
 require "openssl"
-require "always_verify_ssl_certificates"
+#require "always_verify_ssl_certificates"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yellow-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors: