pandexio 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d09ed0b91e468d7feba7093a009224a310e77766
-  data.tar.gz: ac4d71c496c6769bc4b95a0e7514597ef3c0df7a
+  metadata.gz: 11d0ae57fd72c6ad78f545813885cccb081cf150
+  data.tar.gz: b1576bd2c258a559c6e95b699dd685ed650dbacb
 SHA512:
-  metadata.gz: 48d13f7f4055315ad4ff67efd8d6ceecbe83355f1acf27ba695af5618389902c67ba606d6018d9bcbcc0fed9847c1352aa62b687c431916fb31b823cde364174
-  data.tar.gz: 44d1a250babf03e9083bcac1f2f53b73477879563d056b0ef2c9d062aea05b5707d4f598c9c89ac069b85c10404ceb7eaa608d2246a829ef831d7585b7a27592
+  metadata.gz: 91fe4c64f017985f897317166cdf8793d27d548e6907c29ccd970b670a8cd591fb97cc47cc763335d627e50b7b65b03161f28ba139d59efcb369dbbf73d087cc
+  data.tar.gz: 65cb8adb6cfa96e496d43cd5eb2af3c121cf4097e76e66f435d29ae4f4012cc00ce988fe1533a563ebc0ccb1fcb8bf7cea3e9bb75e5e0c4ef45c2a0da56f9de3

data/README.md

@@ -0,0 +1,78 @@
+#Pandexio SDK for Ruby
+
+##Overview
+This Pandexio SDK enables Ruby server applications to easily generate signed requests that can be consumed by the Pandexio REST API (https://platform.pandexio.com) and the Pandexio Hosted Model (https://hosted.pandexio.com).
+
+##Definitions
+
+###Pandexio::Request
+- type - class
+- attributes:
+  - method - required. The request HTTP verb (GET, POST, PUT, PATCH, DELETE).
+  - path - required. The path part of the request URL (e.g., /v2/documents/a4df7a95-d1f6-4664-b208-74568990bd15).
+  - query_parameters - optional. A hash containing the query parameters (e.g., { "coverSize" => "xl" }).
+  - headers - required. A hash containing the headers (e.g., { "Host" => "platform.pandexio.com" }). Host header must be included.
+  - payload - optional. UTF-8 encoded request body. Only applicable for POST, PUT, and PATCH requests.
+
+###Pandexio::SigningOptions
+- type - class
+- attributes:
+  - algorithm - required. The HMAC algorithm to use. Choose from any specified in 
+    - Pandexio::SigningAlgorithms::PDX_HMAC_MD5 - MD5 HMAC
+    - Pandexio::SigningAlgorithms::PDX_HMAC_SHA1 - SHA1 HMAC
+    - Pandexio::SigningAlgorithms::PDX_HMAC_SHA256 - SHA256 HMAC
+    - Pandexio::SigningAlgorithms::PDX_HMAC_SHA384 - SHA384 HMAC
+    - Pandexio::SigningAlgorithms::PDX_HMAC_SHA512 - SHA512 HMAC
+  - mechanism - required. Specifies which signing mechanism to use. Signing mechanisms include:
+    - Pandexio::SigningMechanisms::QUERY_STRING - Sign the request using query string parameters
+    - Pandexio::SigningMechanisms::HEADER - Sign the request using headers
+  - domain_id - required. Public API key.
+  - domain_key - required. Shared secret API key used to generate HMAC signatures.
+  - date - required. ISO8601 date/time when the request was made.
+  - expires - required. Number of seconds before the request signature expires.
+  - originator - required. The name of the application, feature, etc. making the request.
+  - email_address - required. The email address of the user making the request.
+  - display_name - required. The display name of the user making the request.
+  - profile_image - optional. The profile image thumbnail, either data URL or HTTP URL of the user making the request.
+
+###Pandexio::to_authorized_request
+- type - method
+- arguments
+  - Pandexio::Request *normalized_request* - A non-signed request containing information about the request to be made.
+  - Pandexio::SigningOptions *signing_options* - The details specifying how to sign the *normalized_request*
+- result
+  - Pandexio::Request *authorized_request* - A signed request containing information about the request to be made as well as signing information as headers or query string parameters, depending on the *signing_options*.
+
+##Signing a Request
+Take the following steps to create a signed Pandexio request.
+
+1. Create an instance of Pandexio::Request containing details of the request to be made, the *normalized_request*.
+2. Create an instance of Pandexio::SigningOptions. These *signing_options* specify the SDK will sign the request.
+3. Call Pandexio::to_authorized_request, passing in the *normalized_request* and the *signing_options*.
+4. Build an HTTP request using the Pandexio::Request, *authorized_request*, returned by Pandexio::to_authorized_request and make the HTTP request using the HTTP client of choice.
+
+##All Together
+Here's an example showing the generation of a signed Pandexio request to retrieve an extra large document cover thumbnail for a given document:
+
+```ruby
+require 'pandexio'
+
+normalized_request = Pandexio::Request.new(
+  :method => "GET",
+  :path => "/v2/documents/a4df7a95-d1f6-4664-b208-74568990bd15/cover",
+  :query_parameters => { "coverSize" => "xl" },
+  :headers => { "Host" => "platform.pandexio.com" })
+
+signing_options = Pandexio::SigningOptions.new(
+  :algorithm => Pandexio::SigningAlgorithms::PDX_HMAC_SHA256,
+  :mechanism => Pandexio::SigningMechanisms::QUERY_STRING,
+  :domain_id => "1234567890",
+  :domain_key => "asdfjklqwerzxcv",
+  :date => Time.utc(2015, 6, 10, 13, 22, 46),
+  :expires => 90,
+  :originator => "Demo",
+  :email_address => "terry@contoso.com",
+  :display_name => "Terry Contoso")
+
+authorized_request = Pandexio::to_authorized_request(normalized_request, signing_options)
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test

data/test/test_header_signing.rb

@@ -1,5 +1,5 @@
 require 'minitest/autorun'
-require_relative '../lib/module.rb'
+require_relative '../lib/pandexio.rb'
 
 describe Pandexio do
   before do
@@ -24,7 +24,6 @@ describe Pandexio do
       :display_name => "Anonymous")
 
     @authorized_request = Pandexio::to_authorized_request(normalized_request, signing_options)
-    @authorized_request = Pandexio::to_authorized_request(normalized_request, signing_options)
   end
 
   describe "#header_signing" do

data/test/test_query_string_signing.rb

@@ -1,5 +1,5 @@
 require 'minitest/autorun'
-require_relative '../lib/module.rb'
+require_relative '../lib/pandexio.rb'
 
 describe Pandexio do
   before do
@@ -24,7 +24,6 @@ describe Pandexio do
       :display_name => "Anonymous")
 
     @authorized_request = Pandexio::to_authorized_request(normalized_request, signing_options)
-    @authorized_request = Pandexio::to_authorized_request(normalized_request, signing_options)
   end
 
   describe "#query_string_signing" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pandexio
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Brandon Varilone
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-10 00:00:00.000000000 Z
+date: 2015-06-11 00:00:00.000000000 Z
 dependencies: []
 description: Pandexio SDK for Ruby
 email: bvarilone@gmail.com
@@ -16,7 +16,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/module.rb
+- README.md
+- Rakefile
+- lib/pandexio.rb
 - lib/request.rb
 - lib/signing_algorithms.rb
 - lib/signing_attributes.rb