givepulse 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fe721dd37c3ca346dd249b72a769c24d446a59f2
+  data.tar.gz: 37cd624c01067b1775cf61c52e1aeb949e3e7cfb
+SHA512:
+  metadata.gz: 2d32120692ea04b40aeb6de149e9e42e4206c135d52b56e1473cfadf19c18a8145bfe6feed28ab7828c47bc29a733fd04a4dc04ccf7fbb9bfd661bdf383b3af8
+  data.tar.gz: 39b044550e70ce56fe8b94b481f3cdadd5cf99a0ade9c239e8524bb1f5401caad36f13f6f92bf0a68570bd8970d14787f430a6d661767aa1c700bb36f515bc75

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.env
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Layout/IndentationWidth:
+  Width: 4
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in givepulse-rb.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Archer Malmo
+
+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,103 @@
+# Givepulse
+
+This gem is a wrapper library around Givepulse's API providing a simple set of Ruby classes around interacting with your Givepulse data.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'givepulse'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install givepulse
+
+## Usage
+
+### Initializing an API client
+
+First thing you must do when using this API is initialize a client and pass in your API authentication information and then call `:authorize` on your client object.
+
+```ruby
+require 'givepulse'
+
+@client = Givepulse::Client.new(
+    consumer_key: 'sample_consumer_key',
+    consumer_secret: 'sample_consumer_secret',
+    user_email: 'sample@user.com',
+    user_password: 'sample_password'
+)
+@client.authorize
+```
+
+### Accessing data from API endpoints
+
+Once you have initialized a client object, you can begin grabbing data from the API to use in your application. Not all REST endpoints are supported on every API resource, refer to the Givepulse API documentation to see what is available.
+
+Using the client object follows an API like this
+
+```ruby
+affiliations = @client.affiliations.get
+
+new_affiliation = @client.affiliations.create({
+    'group1_id' => '12345',
+    'group2_id' => '12346',
+    'notify' => 'yes'
+})
+
+updated_affiliation = @client.affiliations.update(12345, {
+    'approve' => 'yes'
+})
+
+deleted_affiliation = @client.affiliations.delete(12345)
+```
+
+### Filtering API responses
+
+You can add filter and search data to GET requests by passing in Ruby objects to `:get` calls following the parameters documented in the Givepulse API documentation.
+
+```ruby
+admin_users = @client.users.get({
+    'role' => 'admin'
+})
+```
+
+### Using responses
+
+All responses are returned as plain Ruby objects parsed from the JSON responses given by the API. So, you can use the returned data just like any other Ruby object.
+
+```ruby
+users = @client.users.get
+
+first_user_email = users[:results][0][:email]
+```
+
+### Re-authorization
+
+Authorization tokens for the API expire after two hours. The client object will automatically keep track of the time passed since authorization for you. To check if your token has expired, you can use the `:authorized?` method and call `:authorize` automatically if your token is expired to refresh it.
+
+```ruby
+unless @client.authorized?
+    @client.authorize
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/archermalmo/givepulse.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'givepulse'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'dotenv/load'
+credentials = {
+    consumer_key: ENV['CONSUMER_KEY'],
+    consumer_secret: ENV['CONSUMER_SECRET'],
+    user_email: ENV['USER_EMAIL'],
+    user_password: ENV['USER_PASSWORD']
+}
+
+@givepulse_client = Givepulse::Client.new(credentials)
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/givepulse.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'givepulse/version'
+
+Gem::Specification.new do |spec|
+    spec.name          = 'givepulse'
+    spec.version       = Givepulse::VERSION
+    spec.authors       = ['Archer Malmo']
+    spec.email         = ['support@archermalmo.com']
+
+    spec.summary       = "A wrapper gem around Givepulse's API"
+    spec.description   = "A wrapper gem around Givepulse's API"
+    spec.homepage      = 'https://github.com/archermalmo/givepulse'
+    spec.license       = 'MIT'
+
+    spec.files = `git ls-files -z`.split("\x0").reject do |f|
+        f.match(%r{^(test|spec|features)/})
+    end
+    spec.bindir        = 'exe'
+    spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+    spec.require_paths = ['lib']
+
+    spec.add_development_dependency 'bundler', '~> 1.15'
+    spec.add_development_dependency 'dotenv', '~> 2.2'
+    spec.add_development_dependency 'pry', '~> 0.11'
+    spec.add_development_dependency 'rake', '~> 10.0'
+    spec.add_development_dependency 'rspec', '~> 3.0'
+    spec.add_development_dependency 'rubocop', '~> 0.51'
+    spec.add_development_dependency 'timecop', '~> 0.9'
+    spec.add_development_dependency 'webmock', '~> 3.1'
+end

data/lib/givepulse.rb

@@ -0,0 +1,16 @@
+require 'givepulse/version'
+require 'givepulse/client'
+require 'givepulse/connection'
+require 'givepulse/resource'
+
+require 'givepulse/resources/users'
+require 'givepulse/resources/impacts'
+require 'givepulse/resources/affiliations'
+require 'givepulse/resources/education'
+require 'givepulse/resources/events'
+require 'givepulse/resources/impacts'
+require 'givepulse/resources/groups'
+require 'givepulse/resources/registrations'
+require 'givepulse/resources/memberships'
+
+require 'givepulse/exceptions/unsupported_method'

data/lib/givepulse/client.rb

@@ -0,0 +1,82 @@
+require 'cgi'
+require 'base64'
+require 'givepulse/connection'
+require 'givepulse/resource_map'
+require 'pry'
+
+module Givepulse
+    # Class that will call any methods for retrieving data from the Givepulse API
+    class Client
+        attr_writer :consumer_key
+        attr_writer :consumer_secret
+        attr_writer :user_email
+        attr_writer :user_password
+
+        attr_reader :connection
+
+        def initialize(credentials = nil)
+            # Initialize connection object
+            @connection = Givepulse::Connection.new
+
+            return if credentials.nil?
+            @consumer_key ||= credentials[:consumer_key]
+            @consumer_secret ||= credentials[:consumer_secret]
+            @user_email ||= credentials[:user_email]
+            @user_password ||= credentials[:user_password]
+            @authorization_expiration ||= nil
+        end
+
+        def credentials(credentials)
+            @consumer_key ||= credentials[:consumer_key]
+            @consumer_secret ||= credentials[:consumer_secret]
+            @user_email ||= credentials[:user_email]
+            @user_password ||= credentials[:user_password]
+        end
+
+        def authorize!
+            return false unless @consumer_key && @consumer_secret && @user_email && @user_password
+            custom_headers = {
+                'Authorization' => "Basic #{generate_header_string}"
+            }
+            @connection.with_headers(custom_headers) do |connection|
+                response = connection.post('/auth', nil)
+                return false if response['error']
+                @connection.authorization_token = response['token']
+                @authorization_expiration = Time.new + (60 * 60 * 2)
+            end
+            true
+        end
+
+        def authorized?
+            return false unless @authorization_expiration
+            # Reset the authorization token if it's expired
+            @connection.authorization_token = nil if Time.now > @authorization_expiration
+            Time.now < @authorization_expiration
+        end
+
+        def method_missing(method_name, *args, &block)
+            resource_class = Givepulse::ResourceMap.get_resource_class(method_name)
+            if resource_class
+                resource_class.new(self)
+            else
+                super
+            end
+        end
+
+        def respond_to_missing?(method_name, include_private = false)
+            Givepulse::ResourceMap.get_resource_class(method_name) || super
+        end
+
+        private
+
+        def generate_header_string
+            escaped_values = [
+                CGI.escape(@consumer_key),
+                CGI.escape(@consumer_secret),
+                CGI.escape(@user_email),
+                CGI.escape(@user_password)
+            ]
+            Base64.strict_encode64(escaped_values.join(':'))
+        end
+    end
+end

data/lib/givepulse/connection.rb

@@ -0,0 +1,69 @@
+require 'net/http'
+require 'uri'
+require 'cgi'
+require 'json'
+
+module Givepulse
+    class Connection
+        API_ROOT = URI('https://api2.givepulse.com').freeze
+
+        attr_writer :authorization_token
+
+        def initialize
+            @client = Net::HTTP.new(API_ROOT.host, API_ROOT.port)
+            @client.use_ssl = true
+            @custom_headers = nil
+        end
+
+        def get(path, options = nil)
+            query_string = options_to_query(options)
+            full_path = "#{path}?#{query_string}"
+            response = @client.get(full_path, generate_headers(@custom_headers))
+            JSON.parse(response.body)
+        end
+
+        def post(path, data, options = nil)
+            query_string = options_to_query(options)
+            full_path = "#{path}?#{query_string}"
+            response = @client.post(full_path, data, generate_headers(@custom_headers))
+            JSON.parse(response.body)
+        end
+
+        def put(path, data, options = nil)
+            query_string = options_to_query(options)
+            full_path = "#{path}?#{query_string}"
+            response = @client.put(full_path, data, generate_headers(@custom_headers))
+            JSON.parse(response.body)
+        end
+
+        def delete(path, options = nil)
+            query_string = options_to_query(options)
+            full_path = "#{path}?#{query_string}"
+            response = @client.delete(full_path, generate_headers(@custom_headers))
+            JSON.parse(response.body)
+        end
+
+        def with_headers(headers)
+            @custom_headers = headers
+            yield(self)
+            @custom_headers = nil
+        end
+
+        private
+
+        def generate_headers(custom_headers = nil)
+            headers = custom_headers.nil? ? {} : custom_headers.clone
+            headers['Authorization'] = "Bearer #{@authorization_token}" if @authorization_token
+            headers
+        end
+
+        def options_to_query(options)
+            return if options.nil?
+            query_parameters = []
+            options.each do |key, value|
+                query_parameters.push("#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}")
+            end
+            query_parameters.join('&')
+        end
+    end
+end

data/lib/givepulse/exceptions/unsupported_method.rb

@@ -0,0 +1,7 @@
+module Givepulse
+    class UnsupportedMethod < StandardError
+        def initialize(resource_class)
+            super("This method is not supported on #{resource_class}")
+        end
+    end
+end

data/lib/givepulse/resource.rb

@@ -0,0 +1,33 @@
+module Givepulse
+    class Resource
+        attr_reader :client
+
+        attr_accessor :path
+
+        def initialize(client, path, supported_methods)
+            @client ||= client
+            @path ||= path
+            @supported_methods ||= supported_methods.clone
+        end
+
+        def get(options = nil)
+            raise Givepulse::UnsupportedMethod, self.class unless @supported_methods.include?(__method__)
+            @client.connection.get(@path, options)
+        end
+
+        def create(data)
+            raise Givepulse::UnsupportedMethod, self.class unless @supported_methods.include?(__method__)
+            @client.connection.post(@path, data)
+        end
+
+        def update(id, data)
+            raise Givepulse::UnsupportedMethod, self.class unless @supported_methods.include?(__method__)
+            @client.connection.put("#{@path}/#{id}", data)
+        end
+
+        def delete(id)
+            raise Givepulse::UnsupportedMethod, self.class unless @supported_methods.include?(__method__)
+            @client.connection.delete("#{@path}/#{id}")
+        end
+    end
+end

data/lib/givepulse/resource_map.rb

@@ -0,0 +1,15 @@
+module Givepulse
+    class ResourceMap
+        def self.get_resource_class(resource)
+            resource_classes = Givepulse::Resources.constants.select do |c|
+                Givepulse::Resources.const_get(c).is_a? Class
+            end
+            map = {}
+            resource_classes.each do |resource_class|
+                map[resource_class.to_s.downcase.to_sym] = Givepulse::Resources.const_get(resource_class)
+            end
+            return unless map.key?(resource)
+            map[resource]
+        end
+    end
+end

data/lib/givepulse/resources/affiliations.rb

@@ -0,0 +1,11 @@
+module Givepulse
+    module Resources
+        class Affiliations < Givepulse::Resource
+            SUPPORTED_METHODS = %i[get create update delete].freeze
+
+            def initialize(client)
+                super(client, '/affiliations', SUPPORTED_METHODS)
+            end
+        end
+    end
+end

data/lib/givepulse/resources/education.rb

@@ -0,0 +1,11 @@
+module Givepulse
+    module Resources
+        class Education < Givepulse::Resource
+            SUPPORTED_METHODS = %i[get create update delete].freeze
+
+            def initialize(client)
+                super(client, '/educations', SUPPORTED_METHODS)
+            end
+        end
+    end
+end

data/lib/givepulse/resources/events.rb

@@ -0,0 +1,11 @@
+module Givepulse
+    module Resources
+        class Events < Givepulse::Resource
+            SUPPORTED_METHODS = %i[get].freeze
+
+            def initialize(client)
+                super(client, '/events', SUPPORTED_METHODS)
+            end
+        end
+    end
+end

data/lib/givepulse/resources/groups.rb

@@ -0,0 +1,11 @@
+module Givepulse
+    module Resources
+        class Groups < Givepulse::Resource
+            SUPPORTED_METHODS = %i[get create update].freeze
+
+            def initialize(client)
+                super(client, '/groups', SUPPORTED_METHODS)
+            end
+        end
+    end
+end

data/lib/givepulse/resources/impacts.rb

@@ -0,0 +1,11 @@
+module Givepulse
+    module Resources
+        class Impacts < Givepulse::Resource
+            SUPPORTED_METHODS = %i[get].freeze
+
+            def initialize(client)
+                super(client, '/impacts', SUPPORTED_METHODS)
+            end
+        end
+    end
+end

data/lib/givepulse/resources/memberships.rb

@@ -0,0 +1,11 @@
+module Givepulse
+    module Resources
+        class Memberships < Givepulse::Resource
+            SUPPORTED_METHODS = %i[get create].freeze
+
+            def initialize(client)
+                super(client, '/memberships', SUPPORTED_METHODS)
+            end
+        end
+    end
+end

data/lib/givepulse/resources/registrations.rb

@@ -0,0 +1,11 @@
+module Givepulse
+    module Resources
+        class Registrations < Givepulse::Resource
+            SUPPORTED_METHODS = %i[get].freeze
+
+            def initialize(client)
+                super(client, '/registrations', SUPPORTED_METHODS)
+            end
+        end
+    end
+end

data/lib/givepulse/resources/users.rb

@@ -0,0 +1,11 @@
+module Givepulse
+    module Resources
+        class Users < Givepulse::Resource
+            SUPPORTED_METHODS = %i[get create update].freeze
+
+            def initialize(client)
+                super(client, '/users', SUPPORTED_METHODS)
+            end
+        end
+    end
+end

data/lib/givepulse/version.rb

@@ -0,0 +1,3 @@
+module Givepulse
+    VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: givepulse
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Archer Malmo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: A wrapper gem around Givepulse's API
+email:
+- support@archermalmo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- givepulse.gemspec
+- lib/givepulse.rb
+- lib/givepulse/client.rb
+- lib/givepulse/connection.rb
+- lib/givepulse/exceptions/unsupported_method.rb
+- lib/givepulse/resource.rb
+- lib/givepulse/resource_map.rb
+- lib/givepulse/resources/affiliations.rb
+- lib/givepulse/resources/education.rb
+- lib/givepulse/resources/events.rb
+- lib/givepulse/resources/groups.rb
+- lib/givepulse/resources/impacts.rb
+- lib/givepulse/resources/memberships.rb
+- lib/givepulse/resources/registrations.rb
+- lib/givepulse/resources/users.rb
+- lib/givepulse/version.rb
+homepage: https://github.com/archermalmo/givepulse
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A wrapper gem around Givepulse's API
+test_files: []