social_rebate 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in social_rebate.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 daifu
+
+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/Makefile

@@ -0,0 +1,2 @@
+rebuild:
+	gem build social_rebate.gemspec && gem uninstall social_rebate && gem install social_rebate

data/README.md

@@ -0,0 +1,29 @@
+# SocialRebate
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'social_rebate'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install social_rebate
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/social_rebate.rb

@@ -0,0 +1,6 @@
+require "social_rebate/version"
+require "httparty"
+require "json"
+require "uri"
+
+require "social_rebate/connection"

data/lib/social_rebate/connection.rb

@@ -0,0 +1,107 @@
+module SocialRebate
+  class Connection
+    include HTTParty
+
+    base_uri "socialrebate.net"
+    format   :json
+    STATUS = ['required', 'VERIFIED', 'VOID', 'COUPON']
+
+    class ResponseError < StandardError; end
+
+    def initialize(creds={})
+      validate_creds(creds)
+
+      @configuration = {}
+      SocialRebate::Connection.api_token_keys.each do |key|
+        @configuration[key]   = creds[key].to_s
+      end
+      @store_key              = creds[:store_key]
+      @configuration[:format] = 'json'
+    end
+
+    def self.api_token_keys
+      [:api_key, :api_secret].freeze
+    end
+
+    def self.api_required_keys
+      [:api_key, :api_secret, :store_key].freeze
+    end
+
+    def validate_creds(creds)
+      SocialRebate::Connection.api_required_keys.each do |key|
+        raise ResponseError.new("Required key: #{key} missing") unless creds[key]
+      end
+    end
+
+    def request(method, url, options={})
+      unless api_token_keys_valid?
+        raise ResponseError.new("Please set api_key and api_secret correctly")
+      end
+      options[:body] = options[:body].to_json if options[:body]
+      parsed_response(self.class.__send__(method, url, options))
+    end
+
+    def parsed_response(response)
+      unless response.success?
+        raise ResponseError.new(response)
+      end
+      response.parsed_response
+    end
+
+    def api_token_keys_valid?
+      return SocialRebate::Connection.api_token_keys.detect {|key| @configuration[key] == ''} == nil
+    end
+
+    def serialize_param(params)
+      params.sort.map {|key, value| URI.escape("#{key}=#{value}")}.join('&')
+    end
+
+    def get(url, params={})
+      url   = "#{url}?#{serialize_param(@configuration)}"
+      unless params.empty?
+        url = "#{url}&#{serialize_param(params)}"
+      end
+      request(:get, url)
+    end
+
+    def post(url, body={}, headers={})
+      body.merge!(@configuration).merge!({:store_key => @store_key})
+
+      options = {}
+      options[:body]    = body
+      options[:headers] = set_headers(headers)
+      request(:post, url, options)
+    end
+
+    def put(url, body={}, headers={})
+      check_body_params(body)
+      check_url(url)
+
+      body    = body.merge!(@configuration).merge!({:store_key => @store_key})
+      options = {}
+      options[:body]    = body
+      options[:headers] = set_headers(headers)
+      request(:put, url, options)
+    end
+
+    def set_headers(headers)
+      hash = {}
+      hash = headers unless headers.empty?
+      hash['content-type'] = "application/json"
+      hash['Accept']       = "application/json"
+      hash
+    end
+
+    def check_body_params(body)
+      if !body.key?(:status) || !SocialRebate::Connection::STATUS.include?(body[:status])
+        raise ResponseError.new("Missing or incorrect status param")
+      end
+    end
+
+    def check_url(url)
+      if url !~ /\/orders\/[0-9a-z-A-Z]+\/$/i
+        raise ResponseError.new("Incorrect put url: ../api/v2/orders/<your order id>/")
+      end
+    end
+  end
+end

data/lib/social_rebate/version.rb

@@ -0,0 +1,3 @@
+module SocialRebate
+  VERSION = "0.0.1"
+end

data/social_rebate.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require File.expand_path('../lib/social_rebate/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "social_rebate"
+  spec.version       = SocialRebate::VERSION
+  spec.authors       = ["daifu"]
+  spec.email         = ["daifu.ye@gmail.com"]
+  spec.description   = %q{This is the api wrapper for social rebate}
+  spec.summary       = %q{Social Rebate}
+  spec.homepage      = "http://www.finditparts.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 2.11.0"
+  spec.add_development_dependency "debugger"
+
+  spec.add_dependency "httparty", ">= 0.9.0"
+  spec.add_dependency "json"    , "~> 1.8.0"
+
+end

data/spec/connection_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe SocialRebate::Connection do
+  before :each do
+    @creds        = {:api_key => "your_api_key", :api_secret => "your_api_secret", :store_key => "your_store_key"}
+    @sr           = SocialRebate::Connection.new(@creds)
+    @creds_params = "api_key=your_api_key&api_secret=your_api_secret&format=json"
+    @headers      = {'content-type' => 'application/json', 'Accept' => 'application/json'}
+  end
+
+  context "GET" do
+    describe "connection method" do
+      it "should get last x orders for which social rebate has created a rebate" do
+        @sr.stub(:request).with(:get,"/api/v2/orders/?"+@creds_params+"&limit=20&offset=20")
+        @sr.get("/api/v2/orders/", {:limit => 20, :offset => 20})
+      end
+
+      it "should raise exception with incorrect keys" do
+        expect {
+          @sr.get("/api/v2/orders/")
+        }.to raise_error(SocialRebate::Connection::ResponseError)
+      end
+    end
+  end
+
+  context "POST" do
+    describe "creating orders" do
+      before :each do
+        @body = {:order_email => 'test@fip.com', :total_purchase => 10, :order_id => 1}
+      end
+      it "should create an order" do
+        @sr.stub(:request).with(:post, "/api/v2/orders/", {:body => @body.merge(@creds).merge(:format => 'json'), :headers => @headers})
+        @sr.post("/api/v2/orders/", @body)
+      end
+
+      it "should raise exception with incorrect keys" do
+        expect {
+          @sr.post('/api/v2/orders/', @body)
+        }.to raise_error(SocialRebate::Connection::ResponseError)
+      end
+    end
+  end
+
+  context "PUT" do
+    describe "updating orders" do
+      before :each do
+        @body = {:status => "VOID", :order_email => 'test@fip.com', :total_purchase => '30.0', :order_id => 1}
+      end
+
+      it "should update an order" do
+        @sr.stub(:request).with(:put, "/api/v2/orders/token/", {:body => @body.merge(@creds).merge(:format => 'json'), :headers => @headers})
+        @sr.put("/api/v2/orders/token/", @body)
+      end
+
+      it "should raise exception with incorrect keys" do
+        expect {
+          @sr.put("/api/v2/orders/token/", @body)
+        }.to raise_error(SocialRebate::Connection::ResponseError)
+      end
+
+      it "should raise exception if status is not correct" do
+        @body[:status] = "not_valid"
+        expect {
+          @sr.put("/api/v2/orders/token/", @body)
+        }.to raise_error(SocialRebate::Connection::ResponseError)
+      end
+
+      it "should raise exception if url is incorrect" do
+        expect {
+          @sr.put("/api/v2/orders/", @body)
+        }.to raise_error(SocialRebate::Connection::ResponseError)
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'httparty'
+require 'json'
+Dir[File.dirname(__FILE__)+'/../lib/social_rebate/*.rb'].each{|file| require file}
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: social_rebate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- daifu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: This is the api wrapper for social rebate
+email:
+- daifu.ye@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- lib/social_rebate.rb
+- lib/social_rebate/connection.rb
+- lib/social_rebate/version.rb
+- social_rebate.gemspec
+- spec/connection_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.finditparts.com
+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.24
+signing_key: 
+specification_version: 3
+summary: Social Rebate
+test_files:
+- spec/connection_spec.rb
+- spec/spec_helper.rb