rally_up 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b2bd64acb8f9af4b14ca1914980d050fbf2d54dbb778c53be9da3ad0275d97a5
+  data.tar.gz: cc97a5baa89a8447121f8aab2616f702adb7dbe2ce2f455403eb29403ea37523
+SHA512:
+  metadata.gz: 8c450d30ba3e7fedd22f8cfa29fc644038675a8355f580f4bb2f43d968d4b53cb00c483c8be09db4a66ff6d92967bebabdb55bdb58918f23e9d9c9cbb0a2e9bf
+  data.tar.gz: 53974266d61f735f684117ea2620d90d00c2cfc57b674ffb96ae262dc2f6d31588c4dd3f0a7ddd2f37e9ca58cb663521440b7cb7984e43ae1b5f6a88bd4aad6d

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+rally_up-*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rally_up.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+
+group :development, :test do
+  gem 'pry'
+  gem 'rspec'
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    rally_up (1.0.0)
+      http (~> 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.3)
+    crack (0.4.4)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.13.1)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    hashdiff (1.0.1)
+    http (4.4.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http-parser (1.2.2)
+      ffi-compiler
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    webmock (3.9.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  pry
+  rake (~> 12.0)
+  rally_up!
+  rspec
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 MemberHub
+
+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,64 @@
+# RallyUp Ruby Library
+
+The RallyUp ruby library provides a ruby wrapping around the [RallyUp API](https://api.rallyup.com/) and the [RallyUp Partner API](https://partnerapi.rallyup.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rally_up'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rally_up
+
+## API Usage
+
+```
+require 'rally_up'
+```
+
+## Partner API Usage
+
+```
+require 'rally_up'
+
+# Setup your Partner API Variable
+RallyUp::Partner.domain = 'my.partnerdomain.com'
+RallyUp::Partner.login  = 'login'
+RallyUp::Partner.secret = 's3cr3t'
+
+# Authorization
+RallyUp::Partner::Token.retrieve
+RallyUp::Partner::Token.retrieve(set: false) # to not change RallyUp::Partner.token value
+
+# Once authorized, use the Partner API...
+
+# Campaigns
+RallyUp::Partner::Campaign.list(organization_id: 123)
+RallyUp::Partner::Campaign.retrieve(12345)
+
+# Campaign Items
+RallyUp::Partner::CampaignItem.list(123)
+
+# Organizations
+RallyUp::Partner::Organization.list
+RallyUp::Partner::Organization.list(start_date: '2020-01-01', end_date: '2020-01-30')
+RallyUp::Partner::Organization.retrieve(12345)
+```
+
+## 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/memberhubteam/rally_up.

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rally_up"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/lib/rally_up.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'rally_up/version'
+require 'rally_up/list_object'
+require 'http'
+require 'cgi'
+
+module RallyUp
+  class << self
+    def included(base)
+      base.extend Request
+    end
+  end
+
+  module Request
+    def delete(path, params: {}, headers: {})
+      request(:delete, path, params: params, headers: headers)
+    end
+
+    def get(path, params: {}, headers: {})
+      request(:get, path, params: params, headers: headers)
+    end
+
+    def post(path, params: {}, headers: {})
+      request(:post, path, params: params, headers: headers)
+    end
+
+    def put(path, params: {}, headers: {})
+      request(:put, path, params: params, headers: headers)
+    end
+
+    def request(method, path, domain: 'go.rallyup.com', params: {}, headers: {})
+      request_params = method == :get ? { params: params } : { body: URI.encode_www_form(params) }
+      response = HTTP.headers(headers).send(method, "https://#{domain}#{path}", request_params)
+      verify!(response)
+      response
+    end
+
+    def json(method, path, params: {}, headers: {})
+      response = request(method, path, params: params, headers: headers)
+      JSON.parse(response, symbolize_names: true)
+    end
+
+    protected
+
+    def verify!(response)
+      return if response.code.to_i == 200
+
+      raise Error, response
+    end
+  end
+
+  class Error < StandardError
+    attr_accessor :code, :body
+    def initialize(response)
+      @body = response.body
+      @code = response.code
+    end
+
+    def message
+      "#{code} #{body}"
+    end
+  end
+end
+
+require 'rally_up/partner'

data/lib/rally_up/list_object.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RallyUp
+  class ListObject
+    attr_reader :json, :items, :count, :page_index, :page_size,
+                :total_count, :total_pages,
+                :has_previous_page, :has_next_page
+    def initialize(json_response, klass)
+      @json = json_response
+      if klass
+        @items = json.dig(:Result, :Items).to_a.map do |data|
+          klass.new(data)
+        end
+      end
+      @count = json_response.dig(:Result, :Count)
+      @page_index = json_response.dig(:Result, :PageIndex)
+      @page_size = json_response.dig(:Result, :PageSize)
+      @total_count = json_response.dig(:Result, :TotalCount)
+      @total_pages = json_response.dig(:Result, :TotalPages)
+      @has_previous_page = json_response.dig(:Result, :HasPreviousPage)
+      @has_next_page = json_response.dig(:Result, :HasNextPage)
+    end
+  end
+end

data/lib/rally_up/partner.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RallyUp
+  module Partner
+    include RallyUp
+
+    class << self
+      attr_accessor :login, :secret, :domain, :token
+
+      def request(method, path, domain: RallyUp::Partner.domain, params: {}, headers: {})
+        raise 'Missing RallyUp Partner Token' if RallyUp::Partner.nil?
+
+        super(
+          method,
+          path,
+          domain: domain,
+          params: params,
+          headers: headers.merge('Authorization' => "Bearer #{RallyUp::Partner.token}")
+        )
+      end
+    end
+  end
+end
+
+require 'rally_up/partner/token'
+require 'rally_up/partner/campaign'
+require 'rally_up/partner/campaign_item'
+require 'rally_up/partner/organization'

data/lib/rally_up/partner/campaign.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module RallyUp
+  module Partner
+    class Campaign
+      attr_accessor :id, :name, :url, :campaign_setup_url, :campaign_status,
+                    :start_date_utc, :end_date_utc, :amount_raised,
+                    :amount_raised_in_period, :amount_goal, :goal_period,
+                    :total_views, :total_supporters, :organization_id,
+                    :organization_name, :timezone_name, :utcoffset_minutes,
+                    :time_remaining_minutes, :thumbnail_url, :cta_label,
+                    :management_pages, :primary_currency, :currency_symbol,
+                    :project_id, :fund_code
+
+      def initialize(json)
+        @id = json[:Id]
+        @name = json[:Name]
+        @url = json[:Url]
+        @campaign_setup_url = json[:CampaignSetupUrl]
+        @campaign_status = json[:CampaignStatus]
+        @start_date_utc = json[:StartDateUtc]
+        @end_date_utc = json[:EndDateUtc]
+        @amount_raised = json[:AmountRaised]
+        @amount_raised_in_period = json[:AmountRaisedInPeriod]
+        @amount_goal = json[:AmountGoal]
+        @goal_period = json[:GoalPeriod]
+        @total_views = json[:TotalViews]
+        @total_supporters = json[:TotalSupporters]
+        @organization_id = json[:OrganizationId]
+        @organization_name = json[:OrganizationName]
+        @timezone_name = json[:TimezoneName]
+        @utcoffset_minutes = json[:UtcOffsetMinutes]
+        @time_remaining_minutes = json[:TimeRemainingMinutes]
+        @thumbnail_url = json[:ThumbnailUrl]
+        @cta_label = json[:CtaLabel]
+        @management_pages = json[:ManagementPages]
+        @primary_currency = json[:PrimaryCurrency]
+        @currency_symbol = json[:CurrencySymbol]
+        @project_id = json[:ProjectId]
+        @fund_code = json[:FundCode]
+      end
+
+      class << self
+        def list(
+          organization_id:, # required
+          start_date: nil, # optional
+          end_date: nil, # optional
+          sort_by: nil, # optional
+          campaign_type: nil, # optional
+          include_donation_pages: nil, # optional
+          status: nil # optional
+        )
+          json = RallyUp::Partner.json(:get, '/v1/partnerapi/campaigns', params: {
+            organizationID: organization_id,
+            endDate: end_date,
+            startDate: start_date,
+            sortBy: sort_by,
+            campaignType: campaign_type,
+            includeDonationPages: include_donation_pages,
+            status: status
+          }.reject { |_k, v| v.nil? })
+          RallyUp::ListObject.new(json, self)
+        end
+
+        def retrieve(id)
+          json = RallyUp::Partner.json(:get, "/v1/partnerapi/campaigns/#{id}")
+          new(json[:Result].to_h)
+        end
+      end
+    end
+  end
+end

data/lib/rally_up/partner/campaign_item.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RallyUp
+  module Partner
+    class CampaignItem
+      attr_accessor :id, :campaign_id, :campaign_type, :title, :type,
+                    :terminology_singular, :terminology_plural, :thumbnail_url,
+                    :price, :description, :bundle_quantity,
+                    :total_quantity_available, :total_sold,
+                    :available_start_date, :availableend_date, :availability,
+                    :category, :associated_prize_id, :associated_prize_title
+
+      def initialize(json)
+        @id = json[:Id]
+        @campaign_id = json[:CampaignId]
+        @campaign_type = json[:CampaignType]
+        @title = json[:Title]
+        @type = json[:Type]
+        @terminology_singular = json[:TerminologySingular]
+        @terminology_plural = json[:TerminologyPlural]
+        @thumbnail_url = json[:ThumbnailUrl]
+        @price = json[:Price]
+        @description = json[:Description]
+        @bundle_quantity = json[:BundleQuantity]
+        @total_quantity_available = json[:TotalQuantityAvailable]
+        @total_sold = json[:TotalSold]
+        @available_start_date = json[:AvailableStartDate]
+        @availableend_date = json[:AvailableEndDate]
+        @availability = json[:Availability]
+        @category = json[:Category]
+        @associated_prize_id = json[:AssociatedPrizeId]
+        @associated_prize_title = json[:AssociatedPrizeTitle]
+      end
+
+      class << self
+        def list(campaign_id)
+          json = RallyUp::Partner.json(:get, '/v1/partnerapi/campaignitems', params: {
+                                         campaignID: campaign_id
+                                       })
+          RallyUp::ListObject.new(json, self)
+        end
+      end
+    end
+  end
+end

data/lib/rally_up/partner/organization.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RallyUp
+  module Partner
+    class Organization
+      attr_accessor :id, :ein, :name, :common_name, :email, :url,
+                    :is_tax_exempt, :address, :organization_logo_url,
+                    :organization_website_url, :organization_facebook_url,
+                    :organization_twitter_url, :primary_currency
+
+      def initialize(json)
+        @id = json[:Id]
+        @ein = json[:Ein]
+        @name = json[:Name]
+        @common_name = json[:CommonName]
+        @email = json[:Email]
+        @url = json[:Url]
+        @is_tax_exempt = json[:IsTaxExempt]
+        @address = json[:Address]
+        @organization_logo_url = json[:OrganizationLogoUrl]
+        @organization_website_url = json[:OrganizationWebsiteUrl]
+        @organization_facebook_url = json[:OrganizationFacebookUrl]
+        @organization_twitter_url = json[:OrganizationTwitterUrl]
+        @primary_currency = json[:PrimaryCurrency]
+      end
+
+      class << self
+        def list(start_date: nil, end_date: nil)
+          json = RallyUp::Partner.json(:get, '/v1/partnerapi/organizations', params: {
+            endDate: end_date,
+            startDate: start_date
+          }.reject { |_k, v| v.nil? })
+          RallyUp::ListObject.new(json, self)
+        end
+
+        def retrieve(id)
+          json = RallyUp::Partner.json(:get, "/v1/partnerapi/organizations/#{id}")
+          new(json[:Result].to_h)
+        end
+      end
+    end
+  end
+end

data/lib/rally_up/partner/token.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RallyUp
+  module Partner
+    class Token
+      attr_accessor :access_token, :token_type, :expires_in, :user_name,
+                    :issued, :expires
+
+      def initialize(json)
+        @access_token = json[:access_token]
+        @token_type = json[:token_type]
+        @expires_in = json[:expires_in]
+        @user_name = json[:UserName]
+        @issued = json[:'.issued']
+        @expires = json[:'.expires']
+      end
+
+      class << self
+        def retrieve(set: true)
+          json = RallyUp::Partner.json(:post, '/v1/partnertoken', params: {
+                                         grant_type: 'password',
+                                         username: RallyUp::Partner.login,
+                                         password: RallyUp::Partner.secret
+                                       })
+          token = new(json)
+          RallyUp::Partner.token = token.access_token if set
+          token
+        end
+      end
+    end
+  end
+end

data/lib/rally_up/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RallyUp
+  VERSION = '1.0.0'
+end

data/rally_up.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rally_up/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rally_up'
+  spec.version       = RallyUp::VERSION
+  spec.authors       = ['David Richey']
+  spec.email         = ['david.richey@memberhub.com']
+
+  spec.summary       = 'RallyUp API & Partner API ruby gem'
+  spec.description   = 'RallyUp API & Partner API ruby gem'
+  spec.homepage      = 'https://github.com/memberhubteam/rally_up'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/memberhubteam/rally_up'
+  spec.metadata['changelog_uri'] = 'https://github.com/memberhubteam/rally_up'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 4.0'
+
+  spec.add_dependency 'http', '~> 4.0'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: rally_up
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- David Richey
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: RallyUp API & Partner API ruby gem
+email:
+- david.richey@memberhub.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rally_up.rb
+- lib/rally_up/list_object.rb
+- lib/rally_up/partner.rb
+- lib/rally_up/partner/campaign.rb
+- lib/rally_up/partner/campaign_item.rb
+- lib/rally_up/partner/organization.rb
+- lib/rally_up/partner/token.rb
+- lib/rally_up/version.rb
+- rally_up.gemspec
+homepage: https://github.com/memberhubteam/rally_up
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/memberhubteam/rally_up
+  source_code_uri: https://github.com/memberhubteam/rally_up
+  changelog_uri: https://github.com/memberhubteam/rally_up
+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: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: RallyUp API & Partner API ruby gem
+test_files: []