yellow-sdk 0.0.1

data/README.md

@@ -0,0 +1,63 @@
+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
+```
+
+Examples
+---------
+```
+import json
+import yellow
+
+
+# You can get your api key/secret from your merchant dashboard.
+
+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
+
+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)
+```
+You should see something similar to the following in your terminal:
+```
+{
+    "address": "155xsayoDXxRFP9rxDoecmpVUo7y5xKtc7", # Invoice Address
+    "base_ccy": "USD",
+    "base_price": "0.05",
+    "callback": "https://example.com",
+    "expiration": "2015-03-10T18:17:51.248Z", # Each invoice expires after 10 minutes of creation
+    "id": "6dd264975861fddbfe4404ed995f1ca4", # Invoice ID (to query the invoice later if you need to!)
+    "invoice_ccy": "BTC",
+    "invoice_price": "0.00017070",
+    "received": "0",
+    "redirect": null,
+    "remaining": "0.00017070",
+    "server_time": "2015-03-10T18:07:51.454Z",
+    "status": "new", # Status of the invoice. Other values are "authorizing" for unconfirmed transactions, and "paid" for confirmed transactions
+    "url": "https://cdn.yellowpay.co/invoice.5f0d082e.html?invoiceId=6dd264975861fddbfe4404ed995f1ca4" # Direct URL for the invoice. You can use it to embed the invoice widget in an iframe on your website.
+}
+
+```
+To query an invoice that you created, just pass in the `invoice_id` to the `query_invoice` function:
+```
+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)
+```
+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).
+```
+is_verified = yellow.verify_ipn(api_secret, host_url, request)
+```

data/lib/yellow-sdk/client.rb

@@ -0,0 +1,105 @@
+module Yellow
+
+        VERSION = "0.0.1"
+        YELLOW_SERVER = "https://" + (ENV["YELLOW_SERVER"] || "api.yellowpay.co")
+
+    class YellowApiError < Exception ; end
+
+    class Client
+        def initialize(api_key, api_secret)
+            @api_key = api_key
+            @api_secret = api_secret
+        end
+
+        def create_invoice(hash={})
+            ####
+            # This method creates a yellow invoices based on the following options:
+            #
+            # #param    hash    hash      hash keys matching the expected
+            #                             HTTP arguments described here:
+            #                             http://yellowpay.co/docs/api/#creating-invoices
+            # #returns  JSON parsed data
+            ####
+
+            endpoint = "/v1/invoice/"
+
+            make_request('POST', endpoint, hash.to_json)
+        end
+
+        def query_invoice(invoice_id)
+            ####
+            # Use this method to query an invoice you created earlier using its ID 
+            #
+            # #param    str    invoice_id    the ID of the invoice you're querying
+            # 
+            # #returns  JSON parsed data                                
+            ####
+
+            endpoint = "/v1/invoice/#{invoice_id}/"
+            make_request('GET', endpoint, "")
+        end
+
+        def verify_ipn(host_url, request_signature, request_nonce, request_body)
+            ####
+            # This is a helper method to verify that the request you just received really is from Yellow:
+            #
+            # #param    str    host_url             the callback URL you set when you created the invoice
+            # #param    str    request_signature    the signature header of the request
+            # #param    str    request_nonce        the nonce header of the request
+            # #param    str    request_body         the body of the request
+            #
+            # #returns  boolean
+            ####
+
+            signature = get_signature(host_url, request_body, request_nonce, @api_secret)
+            signature == request_signature ? return true : return false
+        end
+
+        private
+        def make_request(method, endpoint, body)
+            ####
+            # A method used by our SDK to make requests to our server.
+            ####
+
+            url = YELLOW_SERVER + endpoint
+
+            nonce = Time.now.to_i * 1000
+            signature = get_signature(url, body, nonce, @api_secret)
+
+            uri = URI.parse(YELLOW_SERVER)
+            http = Net::HTTP.new(uri.host, uri.port)
+            http.use_ssl = true
+
+            if method == 'GET'
+                request = Net::HTTP::Get.new(endpoint)
+            elsif method == 'POST'
+                request = Net::HTTP::Post.new(endpoint)
+            end
+            
+            request.add_field('Content-Type', 'application/json')
+            request.add_field('API-Key', @api_key)
+            request.add_field('API-Nonce', nonce)
+            request.add_field('API-Sign', signature)
+            request.add_field('API-Platform', "#{RUBY_PLATFORM} - Ruby #{RUBY_VERSION}")
+            request.add_field('API-Version', VERSION)
+            request.body = body
+            response = http.request(request)
+            
+            if response.code == '200'
+                return JSON.parse(response.body)
+            else
+                raise YellowApiError.new(response.body)
+            end     
+        end
+
+        private
+        def get_signature(url, body, nonce, api_secret)
+            ####
+            # A tiny method used by our SDK to sign and verify requests.
+            ####
+
+            message = nonce.to_s + url + body
+            hash    = OpenSSL::HMAC.hexdigest('sha256', api_secret, message)
+        end
+    end
+end

data/lib/yellow-sdk.rb

@@ -0,0 +1,6 @@
+require 'yellow-sdk/client'
+require 'json'
+require 'uri'
+require 'net/http'
+require "openssl"
+require "always_verify_ssl_certificates"

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: yellow-sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eslam A. Hefnawy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-29 00:00:00.000000000 Z
+dependencies: []
+description: Yellow SDK. A ruby module to easily integrate with the Yellow bitcoin
+  payments API.
+email: eslam@yellowpay.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/yellow-sdk.rb
+- lib/yellow-sdk/client.rb
+- README.md
+homepage: http://yellowpay.co
+licenses:
+- Apache 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Yellow SDK. A ruby module to easily integrate with the Yellow bitcoin payments
+  API.
+test_files: []