patreonrb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5ab3e0e7e8c9030e9309ea077b189e5d2afcf8d26848d3b1fcae2611138c4e0e
+  data.tar.gz: caf44ce1048305d57d3e379663a3b0ad85cf7f978de91d7a71d24b1e3d3762d3
+SHA512:
+  metadata.gz: ee4009bffbe0e79f9280d80b251ae9081643a7760b468221c6309c1f8a4bcce52bd0a5cd1dab268222c8e759f3a1acb46e073271366273121543f216e2fe5dc0
+  data.tar.gz: 169e6902cb2fd4813cffd916f60414855ea2456a897a1fc903320db4dcc35b95fccc47a9d7369163673d263fc6adacdb65e84805583cfe50096169900829a44c

data/.env.example

@@ -0,0 +1 @@
+PATREON_ACCESS_TOKEN=

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 12.0"
+gem "dotenv"

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    patreonrb (0.1.0)
+      faraday (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    dotenv (2.7.6)
+    faraday (2.3.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.0.3)
+    rake (12.3.3)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dotenv
+  patreonrb!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.3.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Dean Perry
+
+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,34 @@
+# PatreonRB
+
+**This library is a work in progress**
+
+PatreonRB is a Ruby library for interacting with the Patreon V2 API.
+
+This API isn't great so this library tries to add required fields, such as `user_id` on `Patreon::Member`'s, to 
+make implementing the Patreon API in your application much easier.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "patreonrb"
+```
+
+## Usage
+
+### Set Client Details
+
+Firstly you'll need to set an Access Token, which would be generated using OAuth.
+
+```ruby
+@client = Patreon::Client.new(access_token: "")
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/patreonrb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "patreon"
+
+# 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 = Patreon::Client.new(access_token: ENV["PATREON_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/patreon/client.rb

@@ -0,0 +1,39 @@
+module Patreon
+  class Client
+    BASE_URL = "https://www.patreon.com/api/oauth2/v2"
+
+    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 identity
+      IdentityResource.new(self)
+    end
+
+    def campaigns
+      CampaignsResource.new(self)
+    end
+
+    def members
+      MembersResource.new(self)
+    end
+
+    def connection
+      @connection ||= Faraday.new(BASE_URL) do |conn|
+        conn.request :authorization, :Bearer, access_token
+        conn.request :json
+
+        conn.response :json, content_type: "application/vnd.api+json"
+
+        conn.adapter adapter, @stubs
+      end
+    end
+
+  end
+end

data/lib/patreon/collection.rb

@@ -0,0 +1,29 @@
+module Patreon
+  class Collection
+    attr_reader :data, :total
+
+    def self.from_response(response, type:, key: nil)
+      body = response.body
+
+      if key.is_a?(String)
+        if body[key]
+          data = body[key].map { |attrs| type.new(attrs) }
+        else
+          data = []
+        end
+      else
+        data = body.map { |attrs| type.new(attrs) }
+      end
+
+      new(
+        data: data,
+        total: data.count
+      )
+    end
+
+    def initialize(data:, total:)
+      @data = data
+      @total = total
+    end
+  end
+end

data/lib/patreon/error.rb

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

data/lib/patreon/object.rb

@@ -0,0 +1,24 @@
+require "ostruct"
+
+module Patreon
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        if obj["attributes"]
+          # Merge the attributes 
+          OpenStruct.new(obj["attributes"].map { |key, val| [key, to_ostruct(val)] }.to_h)
+        else
+          OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+        end
+      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/patreon/objects/address.rb

@@ -0,0 +1,13 @@
+module Patreon
+  class Address < Patreon::Object
+
+    DEFAULT_FIELDS = "addressee,city,country,created_at,line_1,line_2,phone_number,postal_code,state"
+
+    def initialize(options = {})
+      super options
+
+      self.id = options["id"] if options["id"]
+    end
+
+  end
+end

data/lib/patreon/objects/benefit.rb

@@ -0,0 +1,13 @@
+module Patreon
+  class Benefit < Patreon::Object
+
+    DEFAULT_FIELDS = "app_external_id,app_meta,benefit_type,created_at,deliverables_due_today_count,delivered_deliverables_count,description,is_deleted,is_ended,is_published,next_deliverable_due_date,not_delivered_deliverables_count,rule_type,tiers_count,title"
+
+    def initialize(options = {})
+      super options
+
+      self.id = options["id"] if options["id"]
+    end
+
+  end
+end

data/lib/patreon/objects/campaign.rb

@@ -0,0 +1,13 @@
+module Patreon
+  class Campaign < Patreon::Object
+
+    DEFAULT_FIELDS = "created_at,creation_name,discord_server_id,google_analytics_id,has_rss,has_sent_rss_notify,image_small_url,image_url,is_charged_immediately,is_monthly,is_nsfw,main_video_embed,main_video_url,one_liner,patron_count,pay_per_name,pledge_url,published_at,rss_artwork_url,rss_feed_title,show_earnings,summary,thanks_embed,thanks_msg,thanks_video_url,url,vanity"
+
+    def initialize(options = {})
+      super options
+
+      self.id = options["id"] if options["id"]
+    end
+
+  end
+end

data/lib/patreon/objects/goal.rb

@@ -0,0 +1,13 @@
+module Patreon
+  class Goal < Patreon::Object
+
+    DEFAULT_FIELDS = "amount_cents,completed_percentage,created_at,description,reached_at,title"
+
+    def initialize(options = {})
+      super options
+
+      self.id = options["id"] if options["id"]
+    end
+
+  end
+end

data/lib/patreon/objects/identity.rb

@@ -0,0 +1,7 @@
+module Patreon
+  class Identity < Patreon::Object
+
+    DEFAULT_FIELDS = "about,can_see_nsfw,created,email,first_name,full_name,hide_pledges,image_url,is_email_verified,last_name,like_count,social_connections,thumb_url,url,vanity"
+
+  end
+end

data/lib/patreon/objects/member.rb

@@ -0,0 +1,35 @@
+module Patreon
+  class Member < Patreon::Object
+
+    DEFAULT_FIELDS = "campaign_lifetime_support_cents,currently_entitled_amount_cents,email,full_name,is_follower,last_charge_date,last_charge_status,lifetime_support_cents,next_charge_date,note,patron_status,pledge_cadence,pledge_relationship_start,will_pay_amount_cents"
+
+    def initialize(options = {})
+      super options
+
+      self.id = options["id"] if options["id"]
+
+      if options["relationships"] && options["relationships"]["currently_entitled_tiers"]
+        self.currently_entitled_tiers = options["relationships"]["currently_entitled_tiers"]["data"]
+      end
+
+      if options["relationships"]
+        self.relationships = options["relationships"].map {|r| { r[0] => r[1]['data']['id'] } }
+
+        options["relationships"].each do |rel|
+          rel_type = rel[1]["data"]["type"]
+          rel_id   = rel[1]["data"]["id"]
+
+          case rel_type
+          when "user"
+            self.user_id = rel_id
+          when "campaign"
+            self.campaign_id = rel_id
+          end
+        end
+      end
+
+      # self.included = options["included"]
+    end
+
+  end
+end

data/lib/patreon/objects/tier.rb

@@ -0,0 +1,13 @@
+module Patreon
+  class Tier < Patreon::Object
+
+    DEFAULT_FIELDS = "amount_cents,created_at,description,discord_role_ids,edited_at,image_url,patron_count,post_count,published,published_at,remaining,requires_shipping,title,unpublished_at,url,user_limit"
+
+    def initialize(options = {})
+      super options
+
+      self.id = options["id"] if options["id"]
+    end
+
+  end
+end

data/lib/patreon/objects/user.rb

@@ -0,0 +1,13 @@
+module Patreon
+  class User < Patreon::Object
+
+    DEFAULT_FIELDS = "about,can_see_nsfw,created,email,first_name,full_name,hide_pledges,image_url,is_email_verified,last_name,like_count,social_connections,thumb_url,url,vanity"
+
+    def initialize(options = {})
+      super options
+
+      self.id = options["id"] if options["id"]
+    end
+
+  end
+end

data/lib/patreon/resource.rb

@@ -0,0 +1,53 @@
+module Patreon
+  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}'"
+      when 401
+        raise Error, "Error 401: You did not supply valid authentication credentials."
+      when 403
+        raise Error, "Error 403: You are not allowed to perform that action."
+      when 404
+        raise Error, "Error 404: No results were found for your request."
+      when 409
+        raise Error, "Error 409: Your request was a conflict."
+      when 429
+        raise Error, "Error 429: Your request exceeded the API rate limit."
+      when 500
+        raise Error, "Error 500: We were unable to perform the request due to server-side problems."
+      when 503
+        raise Error, "Error 503: You have been rate limited for sending more than 20 requests per second."
+      end
+      response
+    end
+  end
+end

data/lib/patreon/resources/campaigns.rb

@@ -0,0 +1,40 @@
+module Patreon
+  class CampaignsResource < Resource
+    
+    def list(fields: Campaign::DEFAULT_FIELDS)
+      response = get_request("campaigns?fields[campaign]=#{fields}")
+      Collection.from_response(response, type: Campaign, key: "data")
+    end
+
+    def retrieve(id:, fields: Campaign::DEFAULT_FIELDS)
+      response = get_request("campaigns/#{id}?fields[campaign]=#{fields}")
+      Campaign.new response.body.dig("data")
+    end
+
+    def tiers(id:, fields: Tier::DEFAULT_FIELDS)
+      response = get_request("campaigns/#{id}?include=tiers&fields[tier]=#{fields}")
+      Collection.from_response(response, type: Tier, key: "included")
+    end
+
+    def creator(id:, fields: User::DEFAULT_FIELDS)
+      response = get_request("campaigns/#{id}?include=creator&fields[user]=#{fields}")
+      User.new response.body.dig("included")[0]
+    end
+
+    def benefits(id:, fields: Benefit::DEFAULT_FIELDS)
+      response = get_request("campaigns/#{id}?include=benefits&fields[benefit]=#{fields}")
+      Collection.from_response(response, type: Benefit, key: "included")
+    end
+
+    def goals(id:, fields: Goal::DEFAULT_FIELDS)
+      response = get_request("campaigns/#{id}?include=goals&fields[goal]=#{fields}")
+      Collection.from_response(response, type: Goal, key: "included")
+    end
+
+    def members(id:, member_fields: Member::DEFAULT_FIELDS, user_fields: User::DEFAULT_FIELDS, campaign_fields: Campaign::DEFAULT_FIELDS)
+      response = get_request("campaigns/#{id}/members?include=user,campaign&fields[member]=#{member_fields}&fields[user]=#{user_fields}&fields[campaign]=#{campaign_fields}")
+      Collection.from_response(response, type: Member, key: "data")
+    end
+
+  end
+end

data/lib/patreon/resources/identity.rb

@@ -0,0 +1,15 @@
+module Patreon
+  class IdentityResource < Resource
+
+    def retrieve(fields: Identity::DEFAULT_FIELDS)
+      response = get_request("identity?fields[user]=#{fields}")
+      User.new response.body["data"]
+    end
+
+    def memberships(fields: Member::DEFAULT_FIELDS)
+      response = get_request("identity?include=memberships&fields[member]=#{fields}")
+      Collection.from_response(response, type: Member, key: "included")
+    end
+
+  end
+end

data/lib/patreon/resources/members.rb

@@ -0,0 +1,19 @@
+module Patreon
+  class MembersResource < Resource
+    
+    def retrieve(member_id:, fields: Member::DEFAULT_FIELDS)
+
+      response = get_request("members/#{member_id}?include=currently_entitled_tiers&fields[member]=#{fields}&fields[tier]=#{Tier::DEFAULT_FIELDS}")#.body#.dig("data")[0]
+      response.body
+
+    end
+
+    def address(member_id:, fields: Address::DEFAULT_FIELDS)
+
+      response = get_request("members/#{member_id}?include=address&fields[address]=#{fields}")#.body#.dig("data")[0]
+      response.body
+
+    end
+
+  end
+end

data/lib/patreon/version.rb

@@ -0,0 +1,3 @@
+module Patreon
+  VERSION = "0.1.0"
+end

data/lib/patreon.rb

@@ -0,0 +1,26 @@
+require "faraday"
+require "json"
+require "patreon/version"
+
+module Patreon
+
+  autoload :Client, "patreon/client"
+  autoload :Collection, "patreon/collection"
+  autoload :Error, "patreon/error"
+  autoload :Resource, "patreon/resource"
+  autoload :Object, "patreon/object"
+
+  autoload :IdentityResource, "patreon/resources/identity"
+  autoload :CampaignsResource, "patreon/resources/campaigns"
+  autoload :MembersResource, "patreon/resources/members"
+  
+  autoload :Identity, "patreon/objects/identity"
+  autoload :Campaign, "patreon/objects/campaign"
+  autoload :Member, "patreon/objects/member"
+  autoload :Benefit, "patreon/objects/benefit"
+  autoload :Tier, "patreon/objects/tier"
+  autoload :User, "patreon/objects/user"
+  autoload :Goal, "patreon/objects/goal"
+  autoload :Address, "patreon/objects/address"
+
+end

data/lib/patreonrb.rb

@@ -0,0 +1 @@
+require "patreon"

data/patreonrb.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/patreon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "patreonrb"
+  spec.version       = Patreon::VERSION
+  spec.authors       = ["Dean Perry"]
+  spec.email         = ["dean@deanpcmad.com"]
+
+  spec.summary       = "A Ruby library for interacting with the Patreon V2 API"
+  spec.homepage      = "https://deanpcmad.com"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/deanpcmad/patreonrb"
+  # 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('..', __FILE__)) 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_dependency "faraday", "~> 2.0"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: patreonrb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Perry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- dean@deanpcmad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/patreon.rb
+- lib/patreon/client.rb
+- lib/patreon/collection.rb
+- lib/patreon/error.rb
+- lib/patreon/object.rb
+- lib/patreon/objects/address.rb
+- lib/patreon/objects/benefit.rb
+- lib/patreon/objects/campaign.rb
+- lib/patreon/objects/goal.rb
+- lib/patreon/objects/identity.rb
+- lib/patreon/objects/member.rb
+- lib/patreon/objects/tier.rb
+- lib/patreon/objects/user.rb
+- lib/patreon/resource.rb
+- lib/patreon/resources/campaigns.rb
+- lib/patreon/resources/identity.rb
+- lib/patreon/resources/members.rb
+- lib/patreon/version.rb
+- lib/patreonrb.rb
+- patreonrb.gemspec
+homepage: https://deanpcmad.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://deanpcmad.com
+  source_code_uri: https://github.com/deanpcmad/patreonrb
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: A Ruby library for interacting with the Patreon V2 API
+test_files: []