vingd 0.1.2

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright 2013 Vingd, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/vingd.rb

@@ -0,0 +1,176 @@
+require 'net/http'
+require "base64"
+require "uri"
+require 'json'
+require 'date'
+
+require 'vingd/response'
+require 'vingd/exceptions'
+
+class Vingd
+  VERSION = "0.1.2"
+
+  # production urls
+  URL_ENDPOINT = "https://api.vingd.com/broker/v1"
+  URL_FRONTEND = "https://www.vingd.com"
+  # sandbox urls
+  URL_ENDPOINT_SANDBOX = "https://api.vingd.com/sandbox/broker/v1"
+  URL_FRONTEND_SANDBOX = "https://www.sandbox.vingd.com"
+
+  # Vingd Client init.
+  # Requires API `key`, `secret`.
+  # API `endpoint` URL and user `frontend` can be set when testing on sandbox.
+  def initialize(api_key, api_secret, api_endpoint, usr_frontend)
+    @api_key = api_key
+    @api_secret = api_secret
+    @api_endpoint = api_endpoint
+    @usr_frontend = usr_frontend
+    @credentials = Base64.strict_encode64(api_key  + ':' + @api_secret)
+  end
+  
+  def request(verb, subpath, data=nil)
+    uri = URI.parse(@api_endpoint + '/' + subpath)
+    http = Net::HTTP.new(uri.host, 443)
+    http.use_ssl = true
+    method = nil
+    case verb.downcase
+    when 'get'
+      method = Net::HTTP::Get
+    when 'post'
+      method = Net::HTTP::Post
+    else
+      raise VingdError, 'Invalid request method'
+    end
+    request = method.new(uri.request_uri)
+    request['user-agent'] = "vingd-api-ruby/#{Vingd::VERSION}"
+    request['authorization'] = 'Basic ' + @credentials
+    begin
+      response = http.request(request, data)
+    rescue
+      raise InternalError, 'HTTP request failed! (Network error? Installation error?)'
+    end
+    begin
+      code = response.code.to_i
+      content = JSON.parse(response.body)
+    rescue
+      raise VingdError, 'Non-JSON server response'
+    end
+    if (200..299).include?(code)
+      begin
+        return content['data']
+      rescue
+        raise InvalidData, 'Invalid server DATA response format!'
+      end
+    end
+    begin
+      message = content['message']
+      context = content['context']
+    rescue
+      raise InvalidData, 'Invalid server ERROR response format!'
+    end
+    case code
+    when Codes::BAD_REQUEST
+      raise InvalidData.new(context), message
+    when Codes::FORBIDDEN
+      raise Forbidden.new(context), message
+    when Codes::NOT_FOUND
+      raise NotFound.new(context), message
+    when Codes::INTERNAL_SERVER_ERROR
+      raise InternalError.new(context), message
+    when Codes::CONFLICT
+      raise VingdError.new(context), message
+    end
+    raise VingdError.new(context, code), message
+  end
+
+  def parse_response(r, name)
+    names = name + 's'
+    data = r[names]
+    if data.is_a?(Array)
+      errors = r['errors']
+      if errors.any?
+        raise VingdError, errors[0]['desc']
+      end
+      return r[names][0]
+    else
+      return r[name]
+    end
+  end
+
+  def get_objects(oid=nil, date_since=nil, date_until=nil, last=nil, first=nil)
+    resource = "registry/objects"
+    oid.nil? or resource+= "/#{oid}"
+    date_since.nil? or resource+= "/since=#{date_since}"
+    date_until.nil? or resource+= "/until=#{date_until}"
+    first.nil? or resource+= "/first=#{first}"
+    last.nil? or resource+= "/last=#{last}"
+    return self.request('get', resource)
+  end
+
+  def get_object(oid)
+    return self.get_objects(oid)
+  end
+  
+  # Registers (enrolls) an object into the Vingd Objects Registry.
+  # Requires object `name` and callback `url`.
+  # Returns Object ID (`oid`) as int.
+  def create_object(name, url)
+    data = JSON.dump({
+      'description' => {
+        "name" => name,
+        "url" => url,
+      }
+    })
+    response = self.request('post', 'registry/objects', data)
+    return self.parse_response(response, 'oid')
+  end
+
+  def create_order(oid, price, context=nil, expires=nil)
+    expires.is_a?(DateTime) or expires = DateTime.now.new_offset(0) + 30
+    data = JSON.dump({
+      'price' => price,
+      'order_expires' => expires.iso8601,
+      'context'=> context,
+    })
+    response = self.request('post', "objects/#{oid}/orders", data)
+    orderid = self.parse_response(response, 'id')
+    return orderid
+  end
+
+  # User `huid` gets `amount` vingd cents (transferred from consumer's acc), or
+  # on failure, an exception gets thrown.  
+  def reward_user(huid_to, amount, description = nil)
+    data = JSON.dump({
+      'huid_to' => huid_to,
+      'amount' => amount,
+      'description' => description,
+    })
+    return self.request('post', 'rewards', data)
+  end
+  
+  # Does delegated (pre-authorized) purchase of `oid` in the name of `huid`, at
+  # price `price` (vingd transferred from `huid` to consumer's acc).
+  # Throws exception on failure.
+  def authorized_purchase_object(oid, price, huid)
+    # autocommit = true, by default
+  end
+  
+  def authorized_purchase_order(orderid, huid)
+  end
+
+  # authorized_create_user(
+  #   {"facebook" => "12312312", "mail" => "user@example.com"},
+  #   "facebook",
+  #   ["get.balance", "delegated.purchase"]
+  # )
+  # Returns Vingd user's `huid` (hashed user id).
+  # Throws exception on failure.
+  def authorized_create_user(identities, primary, delegate_permissions = nil)
+  end
+
+  # Returns account balance (in vingd cents) for user defined with `huid`.
+  def authorized_get_balance(huid)
+  end  
+end
+
+

data/lib/vingd/exceptions.rb

@@ -0,0 +1,31 @@
+require 'vingd/response'
+
+class VingdError < StandardError
+  attr_reader :context, :code
+  DEFAULT_CONTEXT = "Error"
+  DEFAULT_CODE = Codes::CONFLICT
+  def initialize(context=nil, code=nil)
+    @context = (context or self.class::DEFAULT_CONTEXT)
+    @code = (code or self.class::DEFAULT_CODE)
+  end
+end
+
+class InvalidData < VingdError
+  DEFAULT_CONTEXT = "Invalid data"
+  DEFAULT_CODE = Codes::BAD_REQUEST
+end
+
+class Forbidden < VingdError
+  DEFAULT_CONTEXT = "Forbidden"
+  DEFAULT_CODE = Codes::FORBIDDEN
+end
+
+class NotFound < VingdError
+  DEFAULT_CONTEXT = "Not Found"
+  DEFAULT_CODE = Codes::NOT_FOUND
+end
+
+class InternalError < VingdError
+  DEFAULT_CONTEXT = "Internal error"
+  DEFAULT_CODE = Codes::INTERNAL_SERVER_ERROR
+end

data/lib/vingd/response.rb

@@ -0,0 +1,19 @@
+class Codes
+  #Standard HTTP response codes used inside Vingd ecosystem.
+  # success
+  OK = 200
+  CREATED = 201
+  NO_CONTENT = 204
+  PARTIAL_CONTENT = 206
+  # error
+  MULTIPLE_CHOICES = 300
+  MOVED_PERMANENTLY = 301
+  BAD_REQUEST = 400
+  PAYMENT_REQUIRED = 402
+  FORBIDDEN = 403
+  NOT_FOUND = 404
+  CONFLICT = 409
+  GONE = 410
+  INTERNAL_SERVER_ERROR = 500
+  NOT_IMPLEMENTED = 501
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: vingd
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- Vingd, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-20 00:00:00.000000000 Z
+dependencies: []
+description: Vingd enables users to pay with money or with time. See https://www.vingd.com
+  for more.
+email: developers@vingd.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/vingd.rb
+- lib/vingd/response.rb
+- lib/vingd/exceptions.rb
+homepage: https://git.vingd.com/vingd/vingd-api-ruby
+licenses:
+- MIT
+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: Vingd API interface client.
+test_files: []