kindrid_client 0.0.2

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 David Anderson
+
+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,60 @@
+# KindridClient
+
+A Ruby wrapper around the Kindrid API that lets you lookup donations and donors.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kindrid_client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kindrid_client
+
+## Usage
+
+To set up the gem, add keys:
+
+    KindridClient.key = "key"
+    KindridClient.secret = "secret"
+
+
+Now you may run the following commands:
+
+Donations
+
+    KindridClient.donations             # optional limit and offset params (ex: {limit: 15, offset: 2})
+    KindridClient.donations(donor_id)   # optional limit and offset params (ex: {limit: 15, offset: 2})
+    KindridClient.donation(donation_id)
+
+Donors
+
+    KindridClient.donors                # optional limit and offset params (ex: {limit: 15, offset: 2})
+    KindridClient.donor(donor_id)
+
+Tags
+
+    KindridClient.tags(donor_id)
+    KindridClient.tags(donor_id).put({tag_key: "value"})    # add tags
+    KindridClient.tags(donor_id).delete("tag_key")          # remove tag
+
+  
+Also, to consume requests from Kindrid and validate the HMAC with your secret key, use the following:
+
+    KindridClient.consume(request)
+
+
+For more information about the Kindrid API, you can view their api documentation here: http://kindrid.com/dashboard/settings/api/docs
+
+## 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/kindrid_client.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kindrid_client/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "kindrid_client"
+  gem.version       = KindridClient::VERSION
+  gem.authors       = ["David Anderson"]
+  gem.email         = ["davidmartinanderson@gmail.com"]
+  gem.description   = %q{Client gem for the Kindrid service}
+  gem.summary       = %q{Client gem for the Kindrid service}
+  gem.homepage      = ""
+  
+  gem.add_runtime_dependency('rash', '~> 0.3')
+  gem.add_runtime_dependency("faraday")
+  gem.add_runtime_dependency('multi_json', '~> 1.0')
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/kindrid_client.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+require "kindrid_client/version"
+require 'kindrid_client/client'
+require 'kindrid_client/configuration'
+
+module KindridClient
+  extend Configuration
+  
+  mattr_accessor :key, :secret
+  
+  # Alias for KindridClient::Client.new
+  #
+  # @return [KindridClient::Client]
+  def self.new(options={})
+    KindridClient::Client.new(options)
+  end
+
+  # Delegate to KindridClient::Client
+  def self.method_missing(method, *args, &block)
+    return super unless new.respond_to?(method)
+    new.send(method, *args, &block)
+  end
+end

data/lib/kindrid_client/client.rb

@@ -0,0 +1,41 @@
+require 'kindrid_client/configuration'
+require 'kindrid_client/validate'
+require File.expand_path('../request', __FILE__)
+
+module KindridClient
+  class Client
+
+    # @private
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new Client
+    def initialize(options={})
+      options = KindridClient.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+    
+    def consume(request, options = {})
+      unless options[:validate] == false
+        if !validate(request)
+          puts "Incorrect signature"
+          return
+        end
+      end
+      
+      result = Hashie::Mash.new(request.params)
+      result[result.keys.first] unless result.blank?
+    end
+    
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
+    
+    alias :api_endpoint :endpoint
+
+    include Validate
+    include Request
+    include Donation
+    include Donor
+    include Tag
+  end
+end

data/lib/kindrid_client/client/donation.rb

@@ -0,0 +1,29 @@
+module KindridClient
+  module Donation
+    
+    def donations(donor_id = nil, options={})
+      params = {}
+      params.merge!(options)
+
+      # clear empty key/value pairs
+      params.reject! { |key, value| value.nil? }
+      
+      if donor_id.blank?
+        get("donations", params).results
+      else
+        get("donors/#{donor_id}/donations", params).results
+      end
+    end
+    
+    def donation(id, options={})
+      params = {}
+      params.merge!(options)
+
+      # clear empty key/value pairs
+      params.reject! { |key, value| value.nil? }
+
+      get("donations/#{id}", params).results.first 
+    end
+    
+  end
+end

data/lib/kindrid_client/client/donor.rb

@@ -0,0 +1,25 @@
+module KindridClient
+  module Donor
+    
+    def donors(options={})
+      params = {}
+      params.merge!(options)
+
+      # clear empty key/value pairs
+      params.reject! { |key, value| value.nil? }
+
+      get("donors", params).results
+    end
+    
+    def donor(id, options={})
+      params = {}
+      params.merge!(options)
+
+      # clear empty key/value pairs
+      params.reject! { |key, value| value.nil? }
+
+      get("donors/#{id}", params).results.first
+    end
+    
+  end
+end

data/lib/kindrid_client/client/tag.rb

@@ -0,0 +1,34 @@
+module KindridClient
+  module Tag
+    
+    module Extensions
+      
+      def put(data)
+        KindridClient.put("donors/#{self.donor_id}/tags", data)
+      end
+      
+      def delete(tag_key)
+        KindridClient.delete("donors/#{self.donor_id}/tags/#{tag_key}")
+      end
+            
+    end
+    
+    def tags(donor_id, options={})
+      params = {}
+      params.merge!(options)
+
+      # clear empty key/value pairs
+      params.reject! { |key, value| value.nil? }
+
+      # add donor_id to results and allow put and delete methods
+      get("donors/#{donor_id}/tags", params).tap { |response| 
+        response.class.instance_eval do
+          define_method(:donor_id) do
+            response.metadata.resultset.donorID
+          end
+        end
+      }.results.extend(Extensions)
+    end    
+
+  end
+end

data/lib/kindrid_client/configuration.rb

@@ -0,0 +1,61 @@
+require 'faraday'
+require File.expand_path('../version', __FILE__)
+
+module KindridClient
+  # Defines constants and methods related to configuration
+  module Configuration
+
+    # An array of valid keys in the options hash when configuring
+    VALID_OPTIONS_KEYS = [:adapter, :endpoint, :limit, :user_agent, :request_options].freeze
+
+    # The adapter that will be used to connect if none is set
+    #
+    # @note The default faraday adapter is Net::HTTP.
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    # The endpoint that will be used to connect if none is set
+    DEFAULT_ENDPOINT = 'https://kindrid.com/api/v1'.freeze
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "Kindrid Client Gem #{KindridClient::VERSION}".freeze
+    
+    # The default number of results to return from the API
+    DEFAULT_LIMIT = nil
+    
+    # The default request options for Faraday
+    DEFAULT_REQUEST_OPTIONS = {
+      :timeout => 5,
+      :open_timeout => 5
+    }
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+    
+    # Reset all configuration options to defaults
+    def reset
+      self.adapter          = DEFAULT_ADAPTER
+      self.endpoint         = DEFAULT_ENDPOINT
+      self.user_agent       = DEFAULT_USER_AGENT
+      self.request_options  = DEFAULT_REQUEST_OPTIONS
+      self.limit            = DEFAULT_LIMIT
+    end
+
+  end
+end

data/lib/kindrid_client/request.rb

@@ -0,0 +1,67 @@
+module KindridClient
+  module Request
+    
+    # Perform an HTTP GET request
+    def get(resource_path, params = {})
+      request = construct_request(resource_path, params)
+
+      response = connection.get do |req|
+        req.url request[:url], request[:params]
+        req.options = request_options
+      end
+      Hashie::Mash.new(response.body)
+    end
+    
+    def post(resource_path, data)
+      request = construct_request(resource_path)
+
+      response = connection.post do |req|
+        req.url request[:url]
+        req.body = data.to_json
+        req.options = request_options
+      end
+      Hashie::Mash.new(response.body)
+    end
+    
+    def put(resource_path, data)
+      request = construct_request(resource_path)
+
+      response = connection.put do |req|
+        req.url request[:url]
+        req.body = data.to_json
+        req.options = request_options
+      end
+      Hashie::Mash.new(response.body)
+    end
+    
+    def delete(resource_path)
+      request = construct_request(resource_path)
+
+      response = connection.delete do |req|
+        req.url request[:url]
+        req.options = request_options
+      end
+      Hashie::Mash.new(response.body)
+    end
+    
+    def construct_request(resource_path, params={})
+      request = {}
+      request[:url] = "#{Configuration::DEFAULT_ENDPOINT}/#{resource_path}"
+      request[:params] = params.merge({client_id: KindridClient.key})  
+      request    
+    end
+
+    def connection
+      options = {
+        :headers => {'Accept' => 'application/json', 'User-Agent' => user_agent},
+        :url => api_endpoint,
+      }
+
+      Faraday.new(options) do |builder|
+        builder.basic_auth(KindridClient.key, KindridClient.secret)
+        builder.request  :json
+        builder.adapter(adapter)
+      end
+    end
+  end
+end

data/lib/kindrid_client/validate.rb

@@ -0,0 +1,16 @@
+module KindridClient
+  module Validate
+    
+    private
+    
+    def validate(request)
+      message = "#{request.url}#{request.body.read}"
+      digest = OpenSSL::Digest::Digest.new('sha1')
+      hmac = OpenSSL::HMAC.hexdigest(digest, KindridClient.secret, message)
+      request_hmac = request.headers["X-Kindrid-Signature"]
+
+      hmac == request_hmac
+    end
+    
+  end
+end

data/lib/kindrid_client/version.rb

@@ -0,0 +1,3 @@
+module KindridClient
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: kindrid_client
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- David Anderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rash
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Client gem for the Kindrid service
+email:
+- davidmartinanderson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kindrid_client.gemspec
+- lib/kindrid_client.rb
+- lib/kindrid_client/client.rb
+- lib/kindrid_client/client/donation.rb
+- lib/kindrid_client/client/donor.rb
+- lib/kindrid_client/client/tag.rb
+- lib/kindrid_client/configuration.rb
+- lib/kindrid_client/request.rb
+- lib/kindrid_client/validate.rb
+- lib/kindrid_client/version.rb
+homepage: ''
+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: Client gem for the Kindrid service
+test_files: []
+has_rdoc: