tiltify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d05abbdc1199dbe6d1b6fb133619734a3915e1d6e48825fc9f3a304b4bcc55f5
+  data.tar.gz: e2132fcabf47210fc09f515ae40e2b197ef9c22ee25118ba90a70bc3c3f1034a
+SHA512:
+  metadata.gz: 04451dc33eff2f13fde623cafa8e0a1d248d10b36faf7c467f71a5dab1b93eb29cbc01a619f4981794d1017c3db79676af83e07bd1a2b637dedf7526426cae76
+  data.tar.gz: fe89308b9dbe265c8a0ffc87725874cb1c91d244bb79ef5b0e31c68edc8d5894b6328eccb13b7f37ed29f55ffe48d631a6aa323eff8e3b693c997497c58366e1

data/.env.example

@@ -0,0 +1 @@
+TILTIFY_ACCESS_TOKEN=

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in tiltify.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "dotenv"

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    tiltify (0.1.0)
+      faraday (~> 1.7)
+      faraday_middleware (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    dotenv (2.7.6)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    minitest (5.14.4)
+    multipart-post (2.1.1)
+    rake (13.0.6)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  dotenv
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  tiltify!
+
+BUNDLED WITH
+   2.2.29

data/README.md

@@ -0,0 +1,94 @@
+# Tiltify
+
+**This library is a work in progress**
+
+Tiltify is a Ruby library for intereacting with the Tiltify v3 API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "tiltify"
+```
+
+## Usage
+
+### Set Client Details
+
+Firstly, you'll need a Tiltify account in order to create an API Access Token. [More Info](https://tiltify.github.io/api/topics/getting-started.html)
+
+You can get your Access Token by going here (replacing YOURUSERNAME with your username) and creating an application.
+
+```
+https://dashboard.tiltify.com/YOURUSERNAME/my-account/connected-accounts/applications
+```
+
+If you're not planning on using OAuth, you can set the `Redirect URLs` as `https://example.com`. Once created, copy your `Access Token` and save this:
+
+```ruby
+@client = Tiltify::Client.new(access_token: "")
+```
+
+The client then gives you access to each of the resources.
+
+## Resources
+
+The gem maps as closely as we can to the Tiltify API so you can easily convert API examples to gem code.
+
+Responses are created as objects like `Tiltify::Campaign`. Having types like `Tiltify::Campaign` is handy for understanding what type of object you're working with. They're built using OpenStruct so you can easily access data in a Ruby-ish way.
+
+### Campaigns
+
+```ruby
+# Retrieves a single campaign
+@client.campaigns.retrieve(campaign_id: "id")
+
+# Retrieves the most recent donations for a campaign in descending order
+@client.campaigns.donations(campaign_id: "id")
+
+# Retrieves all rewards for a campaign
+@client.campaigns.rewards(campaign_id: "id")
+
+# Retrieves the polls and their associated options for a campaign
+@client.campaigns.polls(campaign_id: "id")
+
+# Retrieves the challenges for a campaign
+@client.campaigns.challenges(campaign_id: "id")
+
+# Retrieves the schedule for a campaign
+@client.campaigns.schedule(campaign_id: "id")
+```
+
+### Causes
+
+```ruby
+# Retrieves a single cause
+@client.causes.retrieve(cause_id: "id")
+```
+
+### Users
+
+```ruby
+# Returns details for the currently authenticated user
+@client.users.me
+
+# Retrieves a specific user by their ID or slug
+@client.users.retrieve(user_id: "id")
+
+# Retrieves a list of a users campaigns
+@client.users.campaigns(user_id: "id")
+
+# Retrieves a list of a teams a user belongs to
+@client.users.teams(user_id: "id")
+```
+
+### Teams
+
+```ruby
+# Retrieves a specific team by their ID or slug
+@client.teams.retrieve(team_id: "id")
+
+# Retrieves a list of a teams campaigns
+@client.teams.campaigns(team_id: "id")
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "tiltify"
+
+# Load environment variables from .env file
+require 'dotenv/load'
+
+# 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
+
+@client = Tiltify::Client.new(access_token: ENV["TILTIFY_ACCESS_TOKEN"])
+
+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/tiltify/client.rb

@@ -0,0 +1,43 @@
+module Tiltify
+  class Client
+    BASE_URL = "https://tiltify.com/api/v3"
+
+    attr_reader :access_token, :adapter
+
+    def initialize(access_token:, adapter: Faraday.default_adapter, stubs: nil)
+      @access_token = access_token
+      @adapter = adapter
+
+      # Test stubs for requests
+      @stubs = stubs
+    end
+
+    def campaigns
+      CampaignsResource.new(self)
+    end
+
+    def causes
+      CausesResource.new(self)
+    end
+
+    def users
+      UsersResource.new(self)
+    end
+
+    def teams
+      TeamsResource.new(self)
+    end
+
+    def connection
+      @connection ||= Faraday.new(BASE_URL) do |conn|
+        conn.request :authorization, :Bearer, access_token
+        conn.request :json
+
+        conn.response :dates
+        conn.response :json, content_type: "application/json"
+
+        conn.adapter adapter, @stubs
+      end
+    end
+  end
+end

data/lib/tiltify/collection.rb

@@ -0,0 +1,21 @@
+module Tiltify
+  class Collection
+    attr_reader :data, :total, :cursor
+
+    def self.from_response(response, type:)
+      body = response.body
+
+      new(
+        data: body["data"].map { |attrs| type.new(attrs) },
+        total: body["data"].count,
+        cursor: body.dig("pagination", "cursor")
+      )
+    end
+
+    def initialize(data:, total:, cursor:)
+      @data = data
+      @total = total
+      @cursor = cursor.nil? ? nil : cursor
+    end
+  end
+end

data/lib/tiltify/error.rb

@@ -0,0 +1,4 @@
+module Tiltify
+  class Error < StandardError
+  end
+end

data/lib/tiltify/object.rb

@@ -0,0 +1,19 @@
+require "ostruct"
+
+module Tiltify
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+  end
+end

data/lib/tiltify/objects/campaign.rb

@@ -0,0 +1,4 @@
+module Tiltify
+  class Campaign < Object
+  end
+end

data/lib/tiltify/objects/cause.rb

@@ -0,0 +1,4 @@
+module Tiltify
+  class Cause < Object
+  end
+end

data/lib/tiltify/objects/challenge.rb

@@ -0,0 +1,4 @@
+module Tiltify
+  class Challenge < Object
+  end
+end

data/lib/tiltify/objects/donation.rb

@@ -0,0 +1,4 @@
+module Tiltify
+  class Donation < Object
+  end
+end

data/lib/tiltify/objects/poll.rb

@@ -0,0 +1,4 @@
+module Tiltify
+  class Poll < Object
+  end
+end

data/lib/tiltify/objects/reward.rb

@@ -0,0 +1,4 @@
+module Tiltify
+  class Reward < Object
+  end
+end

data/lib/tiltify/objects/schedule.rb

@@ -0,0 +1,4 @@
+module Tiltify
+  class Schedule < Object
+  end
+end

data/lib/tiltify/objects/team.rb

@@ -0,0 +1,4 @@
+module Tiltify
+  class Team < Object
+  end
+end

data/lib/tiltify/objects/user.rb

@@ -0,0 +1,4 @@
+module Tiltify
+  class User < Object
+  end
+end

data/lib/tiltify/resource.rb

@@ -0,0 +1,56 @@
+module Tiltify
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    def get_request(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, headers)
+    end
+
+    def post_request(url, body:, headers: {})
+      handle_response client.connection.post(url, body, headers)
+    end
+
+    def patch_request(url, body:, headers: {})
+      handle_response client.connection.patch(url, body, headers)
+    end
+
+    def put_request(url, body:, headers: {})
+      handle_response client.connection.put(url, body, headers)
+    end
+
+    def delete_request(url, params: {}, headers: {})
+      handle_response client.connection.delete(url, params, headers)
+    end
+
+    def handle_response(response)
+      case response.status
+      when 400
+        raise Error, "Error 400: Your request was malformed. '#{response.body["message"]}'"
+      when 401
+        raise Error, "Error 401: You did not supply valid authentication credentials. '#{response.body["error"]}'"
+      when 403
+        raise Error, "Error 403: You are not allowed to perform that action. '#{response.body["error"]}'"
+      when 404
+        raise Error, "Error 404: No results were found for your request. '#{response.body["error"]}'"
+      when 409
+        raise Error, "Error 409: Your request was a conflict. '#{response.body["message"]}'"
+      when 429
+        raise Error, "Error 429: Your request exceeded the API rate limit. '#{response.body["error"]}'"
+      when 500
+        raise Error, "Error 500: We were unable to perform the request due to server-side problems. '#{response.body["error"]}'"
+      when 503
+        raise Error, "Error 503: You have been rate limited for sending more than 20 requests per second. '#{response.body["error"]}'"
+      when 501
+        raise Error, "Error 501: This resource has not been implemented. '#{response.body["error"]}'"
+      end
+
+      response
+    end
+  end
+end

data/lib/tiltify/resources/campaigns.rb

@@ -0,0 +1,34 @@
+module Tiltify
+  class CampaignsResource < Resource
+
+    def retrieve(campaign_id:)
+      Campaign.new get_request("campaigns/#{campaign_id}").body.dig("data")
+    end
+
+    def donations(campaign_id:, **params)
+      response = get_request("campaigns/#{campaign_id}/donations", params)
+      Collection.from_response(response, type: Donation)
+    end
+
+    def rewards(campaign_id:)
+      response = get_request("campaigns/#{campaign_id}/rewards")
+      Collection.from_response(response, type: Reward)
+    end
+
+    def polls(campaign_id:)
+      response = get_request("campaigns/#{campaign_id}/polls")
+      Collection.from_response(response, type: Poll)
+    end
+
+    def challenges(campaign_id:)
+      response = get_request("campaigns/#{campaign_id}/challenges")
+      Collection.from_response(response, type: Challenge)
+    end
+
+    def schedule(campaign_id:)
+      response = get_request("campaigns/#{campaign_id}/schedule")
+      Collection.from_response(response, type: Schedule)
+    end
+    
+  end
+end

data/lib/tiltify/resources/causes.rb

@@ -0,0 +1,9 @@
+module Tiltify
+  class CausesResource < Resource
+
+    def retrieve(cause_id:)
+      Cause.new get_request("causes/#{cause_id}").body.dig("data")
+    end
+    
+  end
+end

data/lib/tiltify/resources/teams.rb

@@ -0,0 +1,14 @@
+module Tiltify
+  class TeamsResource < Resource
+
+    def retrieve(team_id:)
+      Team.new get_request("teams/#{team_id}").body.dig("data")
+    end
+
+    def campaigns(team_id:)
+      response = get_request("teams/#{team_id}/campaigns")
+      Collection.from_response(response, type: Campaign)
+    end
+    
+  end
+end

data/lib/tiltify/resources/users.rb

@@ -0,0 +1,23 @@
+module Tiltify
+  class UsersResource < Resource
+
+    def me
+      User.new get_request("user").body.dig("data")
+    end
+
+    def retrieve(user_id:)
+      User.new get_request("users/#{user_id}").body.dig("data")
+    end
+
+    def campaigns(user_id:)
+      response = get_request("users/#{user_id}/campaigns")
+      Collection.from_response(response, type: Campaign)
+    end
+
+    def teams(user_id:)
+      response = get_request("users/#{user_id}/teams")
+      Collection.from_response(response, type: Team)
+    end
+    
+  end
+end

data/lib/tiltify/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Tiltify
+  VERSION = "0.1.0"
+end

data/lib/tiltify.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday_middleware"
+
+require_relative "tiltify/version"
+
+module Tiltify
+
+  autoload :Client, "tiltify/client"
+  autoload :Collection, "tiltify/collection"
+  autoload :Error, "tiltify/error"
+  autoload :Resource, "tiltify/resource"
+  autoload :Object, "tiltify/object"
+
+  autoload :CampaignsResource, "tiltify/resources/campaigns"
+  autoload :CausesResource, "tiltify/resources/causes"
+  autoload :UsersResource, "tiltify/resources/users"
+  autoload :TeamsResource, "tiltify/resources/teams"
+
+  autoload :Campaign, "tiltify/objects/campaign"
+  autoload :Donation, "tiltify/objects/donation"
+  autoload :Reward, "tiltify/objects/reward"
+  autoload :Poll, "tiltify/objects/poll"
+  autoload :Challenge, "tiltify/objects/challenge"
+  autoload :Schedule, "tiltify/objects/schedule"
+  autoload :Cause, "tiltify/objects/cause"
+  autoload :User, "tiltify/objects/user"
+  autoload :Team, "tiltify/objects/team"
+
+end

data/tiltify.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/tiltify/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tiltify"
+  spec.version       = Tiltify::VERSION
+  spec.authors       = ["Dean Perry"]
+  spec.email         = ["dean@deanpcmad.com"]
+
+  spec.summary       = "A Ruby library for the Tiltify v3 API"
+  spec.homepage      = "https://github.com/deanpcmad/tiltify"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/deanpcmad/tiltify"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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 do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 1.7"
+  spec.add_dependency "faraday_middleware", "~> 1.1"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: tiltify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Perry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: 
+email:
+- dean@deanpcmad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tiltify.rb
+- lib/tiltify/client.rb
+- lib/tiltify/collection.rb
+- lib/tiltify/error.rb
+- lib/tiltify/object.rb
+- lib/tiltify/objects/campaign.rb
+- lib/tiltify/objects/cause.rb
+- lib/tiltify/objects/challenge.rb
+- lib/tiltify/objects/donation.rb
+- lib/tiltify/objects/poll.rb
+- lib/tiltify/objects/reward.rb
+- lib/tiltify/objects/schedule.rb
+- lib/tiltify/objects/team.rb
+- lib/tiltify/objects/user.rb
+- lib/tiltify/resource.rb
+- lib/tiltify/resources/campaigns.rb
+- lib/tiltify/resources/causes.rb
+- lib/tiltify/resources/teams.rb
+- lib/tiltify/resources/users.rb
+- lib/tiltify/version.rb
+- tiltify.gemspec
+homepage: https://github.com/deanpcmad/tiltify
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/deanpcmad/tiltify
+  source_code_uri: https://github.com/deanpcmad/tiltify
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: A Ruby library for the Tiltify v3 API
+test_files: []