zooz 1.0.0

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2012, Michael Alexander
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met: 
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer. 
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution. 
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those
+of the authors and should not be interpreted as representing official policies, 
+either expressed or implied, of Miniand.

data/README.md

@@ -0,0 +1,48 @@
+ZooZ Ruby library
+=================
+
+The ZooZ Ruby library provides an interface to the ZooZ API.  This library is
+purely for API interaction and doesn't provide any Rails helpers.  The upcoming
+Rails ZooZ library will provide Rails helpers.
+
+Installation
+------------
+
+```
+gem install zooz
+```
+
+Opening a transaction
+---------------------
+
+```
+require 'zooz'
+
+req = Zooz::Request::Open.new
+
+# Run in sandbox mode
+req.sandox = true
+
+# Enter your details
+req.unique_id = 'your-unique-id-here'
+req.app_key = 'your-app-key-here'
+
+# Set the details of the transaction
+req.currency_code = 'USD'
+req.amount = 99.99
+
+# Make the request
+resp = req.request
+unless resp
+  raise "Therre was a problem opening a transaction:\n#{req.errors.join(', ')}"
+end
+
+# Use the token and session_token to provide an interface to the customer
+token = resp.token
+session_token = resp.session_token
+```
+
+Verifying a transaction
+-----------------------
+
+Coming soon.

data/lib/zooz/request/open.rb

@@ -0,0 +1,43 @@
+require 'zooz/request'
+require 'zooz/response/open'
+require 'active_support/core_ext/module/delegation'
+
+module Zooz
+  class Request
+    class Open
+      attr_accessor :amount, :currency_code, :requestor
+      attr_reader :errors
+      delegate :sandbox, :sandbox=, :unique_id, :unique_id=, :app_key,
+        :app_key=, :response_type, :response_type=, :cmd, :cmd=, :is_sandbox?,
+        :to => :requestor
+
+      def initialize
+        @errors = []
+        @requestor = Request.new
+        @requestor.cmd = 'openTrx'
+      end
+
+      def request
+        return false unless valid?
+        @requestor.set_param('amount', @amount)
+        @requestor.set_param('currencyCode', @currency_code)
+        open_response = Response::Open.new
+        open_response.request = self
+        open_response.response = @requestor.request
+        unless open_response.response
+          @errors += @requestor.errors
+          return false
+        end
+        open_response
+      end
+
+      def valid?
+        @errors = []
+        @errors << 'amount is required' if @amount.nil?
+        @errors << 'currency_code is required' if @currency_code.nil?
+        @errors += @requestor.errors unless @requestor.valid?
+        @errors.empty?
+      end
+    end
+  end
+end

data/lib/zooz/request/verify.rb

@@ -0,0 +1,41 @@
+require 'zooz/request'
+require 'zooz/response/verify'
+require 'active_support/core_ext/module/delegation'
+
+module Zooz
+  class Request
+    class Verify
+      attr_accessor :trx_id
+      attr_reader :errors
+      delegate :sandbox, :sandbox=, :unique_id, :unique_id=, :app_key,
+        :app_key=, :response_type, :response_type=, :cmd, :cmd=, :is_sandbox?,
+        :to => :requestor
+
+      def initialize
+        @errors = []
+        @requestor = Request.new
+        @requestor.cmd = 'verifyTrx'
+      end
+
+      def request
+        return false unless valid?
+        @requestor.set_param('trxId', @trx_id)
+        verify_response = Response::Verify.new
+        verify_response.request = self
+        verify_response.response = @requestor.request
+        unless verify_response.response
+          @errors += @requestor.errors
+          return false
+        end
+        verify_response
+      end
+
+      def valid?
+        @errors = []
+        @errors << 'trx_id is required' if @trx_id.nil?
+        @errors += @requestor.errors unless @requestor.valid?
+        @errors.empty?
+      end
+    end
+  end
+end

data/lib/zooz/request.rb

@@ -0,0 +1,68 @@
+require 'httparty'
+
+# The ZooZ Request class formats and sends requests to the ZooZ API.
+module Zooz
+  class Request
+    attr_accessor :sandbox, :unique_id, :app_key, :response_type, :cmd
+    attr_reader :errors, :params
+
+    def initialize
+      @params = {}
+      @errors = []
+      @response_type = 'NVP'
+      @sandbox = false
+    end
+
+    # Set a request parameter.
+    def set_param name, value
+      @params[name] = value
+    end
+
+    # Get a request parameter.
+    def get_param
+      @params[name]
+    end
+
+    # Whether the request will be sent to sandbox.
+    def is_sandbox?
+      @sandbox == true
+    end
+
+    # Get the URL of the API, based on whether in sandbox mode or not.
+    def url
+      (is_sandbox? ? 'https://sandbox.zooz.co' : 'https://app.zooz.com') +
+        '/mobile/SecuredWebServlet'
+    end
+
+    # Send a request to the server, returns a Zooz::Response object or false.
+    # If returning false, the @errors attribute is populated.
+    def request
+      return false unless valid?
+      http_response = HTTParty.post(url, :format => :plain,
+        :query => @params.merge({ :cmd => @cmd }),
+        :headers => {
+          'ZooZ-Unique-ID' => @unique_id,
+          'ZooZ-App-Key' => @app_key,
+          'ZooZ-Response-Type' => @response_type,
+        })
+      response = Response.new
+      response.request = self
+      response.http_response = http_response
+      unless response.success?
+        @errors = response.errors
+        return false
+      end
+      response
+    end
+
+    # Whether the request object is valid for requesting.
+    def valid?
+      @errors = []
+      @errors << 'unique_id is required' if @unique_id.nil?
+      @errors << 'app_key is required' if @app_key.nil?
+      @errors << 'cmd is required' if @cmd.nil?
+      @errors << 'response_type is required' if @response_type.nil?
+      @errors.empty?
+    end
+  end
+end

data/lib/zooz/response/open.rb

@@ -0,0 +1,22 @@
+require 'zooz/response'
+require 'active_support/core_ext/module/delegation'
+
+module Zooz
+  class Response
+    class Open
+      attr_accessor :request, :response
+      delegate :success?, :errors, :parsed_response, :get_parsed_singular,
+        :to => :response
+      delegate :is_sandbox?, :unique_id, :app_key, :amount, :currency_code,
+        :to => :request
+
+      def token
+        get_parsed_singular('token')
+      end
+
+      def session_token
+        get_parsed_singular('sessionToken')
+      end
+    end
+  end
+end

data/lib/zooz/response/verify.rb

@@ -0,0 +1,13 @@
+require 'zooz/response'
+require 'active_support/core_ext/module/delegation'
+
+module Zooz
+  class Response
+    class Verify
+      attr_accessor :request, :response
+      delegate :success?, :errors, :parsed_response, :get_parsed_singular,
+        :to => :response
+      delegate :is_sandbox?, :unique_id, :app_key, :trx_id, :to => :request
+    end
+  end
+end

data/lib/zooz/response.rb

@@ -0,0 +1,54 @@
+require 'active_support/core_ext/module/delegation'
+require 'cgi'
+
+# The base level ZooZ response class encapsulates responses from the ZooZ API
+# and reports on success and errors.
+module Zooz
+  class Response
+    attr_accessor :http_response, :request
+    attr_reader :errors
+    delegate :body, :code, :message, :headers, :to => :http_response,
+      :prefix => :http
+    delegate :is_sandbox?, :unique_id, :app_key, :to => :request
+
+    def initialize
+      @errors = []
+    end
+
+    # Gets a singular offset from the response data, useful because CGI returns
+    # single parameters embedded in an array.
+    def get_parsed_singular(offset)
+      (parsed_response[offset] || []).first
+    end
+
+    # Get a parsed response as an object from the response text.
+    def parsed_response
+      CGI::parse(http_body.strip)
+    end
+
+    # Get the ZooZ status code, 0 for success.
+    def status_code
+      get_parsed_singular('statusCode')
+    end
+
+    # Get the ZooZ error message, returned when status_code is not 0.
+    def error_message
+      get_parsed_singular('errorMessage')
+    end
+
+    # Whether the request was successful, populates the @errors array on error.
+    def success?
+      @errors = []
+      unless http_code.to_s[0] == '2'
+        @errors << "HTTP status #{http_code}: #{http_message}"
+      end
+      unless status_code
+        @errors << "Unable to parse ZooZ response"
+      end
+      unless status_code == '0'
+        @errors << "ZooZ error #{status_code}: #{error_message}"
+      end
+      @errors.empty?
+    end
+  end
+end

data/lib/zooz.rb

@@ -0,0 +1,3 @@
+# Require all requests
+require 'zooz/request/open'
+require 'zooz/request/verify'

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: zooz
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Michael Alexander
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: A ZooZ API library for Ruby
+email: beefsack@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/zooz.rb
+- lib/zooz/request/open.rb
+- lib/zooz/request/verify.rb
+- lib/zooz/response/open.rb
+- lib/zooz/response/verify.rb
+- lib/zooz/request.rb
+- lib/zooz/response.rb
+- LICENSE
+- README.md
+homepage: https://github.com/Miniand/zooz-ruby
+licenses: []
+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: ZooZ
+test_files: []