referral_candy 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 ReferralCandy
+
+MIT License
+
+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/README.md

@@ -0,0 +1,46 @@
+# ReferralCandy Ruby API Client
+
+## Installation
+
+    gem install 'referral_candy'
+
+## Usage
+
+### Initialization
+
+Initialize a client with your ReferralCandy credentials
+
+    rc = ReferralCandy.new(:access_id => "YOUR_ACCESS_ID", :secret_key => "YOUR_SECRET_KEY")
+
+### Verification
+
+Verify your credentials.
+
+    response = rc.verify
+    response.parsed_response # => {"message"=>"Verification Ok"}
+    response.code            # => 200
+
+### API Methods
+
+The ReferralCandy API client will perform the [authentication](http://www.referralcandy.com/api#authentication) steps for you.
+This means that you would not be required to pass in the 'timestamp', 'accessID', and 'signature' parameters.
+
+[API endpoints](http://www.referralcandy.com/api) are available as methods in the ReferralCandy API client.
+
+E.g.
+
+    rc.contacts(:limit => 1).parsed_response
+    # => {"message"=>"Success", "total_count"=>10000, "contacts"=>[{"id"=>1, "first_name"=>"Yink", "last_name"=>"Teo", "email"=>"hello@referralcandy.com", "purchase_made"=>false, "purchases"=>[], "unsubscribed"=>true}]}
+
+### Responses
+
+The ReferralCandy API client uses [HTTParty](https://github.com/jnunemaker/httparty).
+
+    rc.verify.class           # => HTTParty::Response
+    rc.verify.body            # => "{\"message\":\"Verification Ok\"}"
+    rc.verify.parsed_response # => {"message"=>"Verification Ok"}
+    rc.verify.code            # => 200
+    rc.verify.header          # => #<Net::HTTPOK 200 OK readbody=true>
+
+## Documentation
+[API documentation](http://www.referralcandy.com/api)

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/referral_candy.rb

@@ -0,0 +1,56 @@
+require 'digest/md5'
+require 'httparty'
+
+class ReferralCandy
+  DEFAULT_API_URL = "https://my.referralcandy.com/api/v1/"
+  API_METHODS = {
+    get:  [:verify, :referrals, :referrer, :contacts],
+    post: [:purchase, :referral, :signup, :invite]
+  }
+
+  include  HTTParty
+  base_uri DEFAULT_API_URL
+  format   :json
+
+  attr_reader :secret_key, :access_id
+  class << self
+    def api_url= url
+      base_uri url
+      @api_url = url
+    end
+    def api_url
+      @api_url || DEFAULT_API_URL
+    end
+  end
+
+  def initialize(options = {})
+    @access_id  = options[:access_id]
+    @secret_key = options[:secret_key]
+  end
+
+  API_METHODS.each do |verb, end_points|
+    end_points.each do |ep|
+      class_eval <<-EVAL
+        def #{ep}(params = {})
+          ReferralCandy.#{verb}("/#{ep}.json", query: add_signature_to(params))
+        end
+      EVAL
+    end
+  end
+
+  private
+
+  def add_signature_to input_params
+    params = input_params.merge({
+      :accessID  => self.access_id,
+      :timestamp => Time.now.to_i
+    })
+    params[:signature] = signature(params)
+    params
+  end
+
+  def signature params = {}
+    collected_params = params.map{|k, v| "#{k}=#{v}"}.sort.join
+    Digest::MD5.hexdigest(self.secret_key + collected_params)
+  end
+end

data/lib/referral_candy/version.rb

@@ -0,0 +1,3 @@
+class ReferralCandy
+  VERSION = '0.1.0'.freeze
+end

data/referral_candy.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/referral_candy/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = 'referral_candy'
+  s.version       = ReferralCandy::VERSION.dup
+  s.date          = '2011-12-12'
+  s.summary       = "ReferralCandy Ruby API Client"
+  s.description   = "Ruby wrapper for ReferralCandy API"
+  s.authors       = ["Yinquan Teo", "Sean Xie Sheng Xiang", "Dinesh Raju"]
+  s.email         = 'hello@referralcandy.com'
+  s.homepage      = 'http://www.referralcandy.com/api'
+
+  s.files         = `git ls-files`.split($\)
+  s.test_files    = s.files.grep(%r{^(spec)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency             "httparty", ">= 0.8.0"
+  s.add_development_dependency "rspec", "~> 2.9.0"
+
+end

data/spec/referral_candy_spec.rb

@@ -0,0 +1,64 @@
+# encoding: UTF-8
+require "spec_helper"
+
+describe ReferralCandy do
+
+  let(:secret_key)        { 'access_token' }
+  let(:access_id)         { 'access_id' }
+  let(:refcandy)          { ReferralCandy.new(access_id: access_id, secret_key: secret_key) }
+  let(:params)            { {:name => "john"} }
+  let(:pre_signed_params) { params.merge(:accessID => access_id, :timestamp => 1) }
+
+  describe ".initialize" do
+    subject { refcandy }
+    its(:secret_key) { should == secret_key }
+    its(:access_id)  { should == access_id }
+  end
+
+  describe "#api_url" do
+    subject { ReferralCandy }
+    its(:api_url) { should == ReferralCandy::DEFAULT_API_URL }
+  end
+
+  describe ".add_signature_to" do
+    it "should add accessID to params" do
+      refcandy.send(:add_signature_to, params)[:accessID].should == access_id
+    end
+    it "should add timestamp to params" do
+      Time.stub(:now).and_return(1)
+      refcandy.send(:add_signature_to, params)[:timestamp].should == 1
+    end
+    it "should add signature to params" do
+      Time.stub(:now).and_return(1)
+      refcandy.send(:add_signature_to, params)[:signature].should == refcandy.send(:signature, pre_signed_params)
+    end
+  end
+  describe ".signature" do
+    it "should calculate the correct signature" do
+      refcandy.send(:signature, pre_signed_params).should == '25cb1ed0c5e9e64f09fa4db9ed7ff156'
+    end
+  end
+
+  describe ".verify" do
+    it "should GET verify.json with correct params" do
+      ReferralCandy.should_receive(:get).once.with("/verify.json", :query => refcandy.send(:add_signature_to, {}))
+      refcandy.verify
+    end
+  end
+
+  describe ".purchase" do
+    let(:purchase_params) {{
+      :first_name      => "John",
+      :last_name       => "Doe",
+      :email           => "john@doe.com",
+      :order_timestamp => Time.now.to_i,
+      :browser_ip      => "123.123.123.123",
+      :user_agent      => "I like iOS",
+      :invoice_amount  => 500,
+    }}
+    it "should POST purchase.json with correct params" do
+      ReferralCandy.should_receive(:post).once.with("/purchase.json", :query => refcandy.send(:add_signature_to, purchase_params))
+      refcandy.purchase(purchase_params)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'referral_candy')

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: referral_candy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Yinquan Teo
+- Sean Xie Sheng Xiang
+- Dinesh Raju
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-12 00:00:00.000000000 Z
+dependencies:
+- !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
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+description: Ruby wrapper for ReferralCandy API
+email: hello@referralcandy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/referral_candy.rb
+- lib/referral_candy/version.rb
+- referral_candy.gemspec
+- spec/referral_candy_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.referralcandy.com/api
+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: ReferralCandy Ruby API Client
+test_files:
+- spec/referral_candy_spec.rb
+- spec/spec_helper.rb