patreon 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bee2755fa7bbe4c0dcb717fb13f8d5cf1b06cee5
-  data.tar.gz: d529a387ad7c3ed3db7827bdd22ac1a3a9bd8b15
+  metadata.gz: ad676d15579d0bcd7c803e890eb2036d2100ec8b
+  data.tar.gz: 322b087b65fd2ebbd21b6dd48a162abf173395e2
 SHA512:
-  metadata.gz: 0c6b2ea5492326a1488fe824053dd338b832abb052f0c1f61d3c57571a684c66348ce1d73c449bdd110bd00c40d5f98b4c5d19262c221efb05d165f65c5c3887
-  data.tar.gz: 777e1d8b36da247e966769486495f9d1b61590bc50a72450b91c879beb53652362c4c52ff6919b67c17bb0e90f48d0dbb986b36c3751d0f782c4e134e694272c
+  metadata.gz: 180b08e913282461e376b555dac658b3434acfef272c6ca86d5e5c2ea05e6d48bb7de3a6dd2f805b7598b9457a14e22f35caba00ff41fb90dc2a0cce0cfdb265
+  data.tar.gz: f167cf347b909ae43c20e8f3304807fff873225bc72e3c921e7792209bb1afa8309582e23bb7d730ffb260ddf28153058b3d62d0ed1955028c787fc96bbebe4d

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,13 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    json-api-vanilla (1.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  json-api-vanilla (~> 1.0.1)
+
+BUNDLED WITH
+   1.15.1

data/README.md

@@ -24,15 +24,12 @@ class OAuthController < ApplicationController
 
     api_client = Patreon::API.new(access_token)
     user_response = api_client.fetch_user()
-    @user = user_response['data']
-    included = user_response['included']
-    if included
-      @pledge = included.find {|obj| obj['type'] == 'pledge' && obj['relationships']['creator']['data']['id'] == creator_id}
-      @campaign = included.find {|obj| obj['type'] == 'campaign' && obj['relationships']['creator']['data']['id'] == creator_id}
-    else
-      @pledge = nil
-      @campaign = nil
-    end
+    # user_response uses [json-api-vanilla](https://github.com/trainline/json-api-vanilla) for easy usage
+    @user = user_response.data
+    # you can list all attributes and relationships with (@user.methods - Object.methods)
+    @pledge = @user.pledges[0]
+    # just like with @user, you can list all pledge attributes and relationships with (@pledge.methods - Object.methods)
+    @pledge_amount = @pledge.amount_cents
   end
 end
 ```

data/example/fetch_all_patrons.rb

@@ -0,0 +1,39 @@
+require_relative 'lib/patreon'
+require 'uri'
+require 'cgi'
+
+# API key constants. Register at https://www.patreon.com/platform to get these values
+# client_id = nil
+# client_secret = nil
+# redirect_uri = nil
+# refresh_token = nil # your Creator Refresh Token
+
+# Fetching updated tokens
+oauth_client = Patreon::OAuth.new(client_id, client_secret)
+tokens = oauth_client.refresh_token(refresh_token, redirect_uri)
+access_token = tokens['access_token']
+
+# Fetching basic data
+api_client = Patreon::API.new(access_token)
+
+campaign_response = api_client.fetch_campaign()
+campaign_id = campaign_response.data[0].id
+
+# Fetching all pledges
+all_pledges = []
+cursor = nil
+while true do
+    page_response = api_client.fetch_page_of_pledges(campaign_id, 25, cursor)
+    all_pledges += page_response.data
+    next_page_link = page_response.links[page_response.data]['next']
+    if next_page_link
+        parsed_query = CGI::parse(next_page_link)
+        cursor = parsed_query['page[cursor]'][0]
+    else
+        break
+    end
+end
+
+# Mapping to all patrons. Feel free to customize as needed.
+# As with all standard Ruby objects, (pledge.methods - Object.methods) will list the available attributes and relationships
+puts all_pledges.map{ |pledge| { full_name: pledge.patron.full_name, amount_cents: pledge.amount_cents } }

data/example/sinatra/.gitignore

@@ -0,0 +1,2 @@
+config.rb
+sqlite.db

data/example/sinatra/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'sinatra', '~>1.4.7'
+gem 'thin',  '~>1.1'
+gem 'haml', '~>4.0.7'
+gem 'data_mapper', '~>1.2.0'
+gem 'dm-sqlite-adapter', '~>1.2.0'
+gem 'patreon', :path => './../../'

data/example/sinatra/Gemfile.lock

@@ -0,0 +1,98 @@
+PATH
+  remote: ./../../
+  specs:
+    patreon (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    bcrypt (3.1.11)
+    bcrypt-ruby (3.1.5)
+      bcrypt (>= 3.1.3)
+    daemons (1.2.4)
+    data_mapper (1.2.0)
+      dm-aggregates (~> 1.2.0)
+      dm-constraints (~> 1.2.0)
+      dm-core (~> 1.2.0)
+      dm-migrations (~> 1.2.0)
+      dm-serializer (~> 1.2.0)
+      dm-timestamps (~> 1.2.0)
+      dm-transactions (~> 1.2.0)
+      dm-types (~> 1.2.0)
+      dm-validations (~> 1.2.0)
+    data_objects (0.10.17)
+      addressable (~> 2.1)
+    dm-aggregates (1.2.0)
+      dm-core (~> 1.2.0)
+    dm-constraints (1.2.0)
+      dm-core (~> 1.2.0)
+    dm-core (1.2.1)
+      addressable (~> 2.3)
+    dm-do-adapter (1.2.0)
+      data_objects (~> 0.10.6)
+      dm-core (~> 1.2.0)
+    dm-migrations (1.2.0)
+      dm-core (~> 1.2.0)
+    dm-serializer (1.2.2)
+      dm-core (~> 1.2.0)
+      fastercsv (~> 1.5)
+      json (~> 1.6)
+      json_pure (~> 1.6)
+      multi_json (~> 1.0)
+    dm-sqlite-adapter (1.2.0)
+      dm-do-adapter (~> 1.2.0)
+      do_sqlite3 (~> 0.10.6)
+    dm-timestamps (1.2.0)
+      dm-core (~> 1.2.0)
+    dm-transactions (1.2.0)
+      dm-core (~> 1.2.0)
+    dm-types (1.2.2)
+      bcrypt-ruby (~> 3.0)
+      dm-core (~> 1.2.0)
+      fastercsv (~> 1.5)
+      json (~> 1.6)
+      multi_json (~> 1.0)
+      stringex (~> 1.4)
+      uuidtools (~> 2.1)
+    dm-validations (1.2.0)
+      dm-core (~> 1.2.0)
+    do_sqlite3 (0.10.17)
+      data_objects (= 0.10.17)
+    eventmachine (1.2.1)
+    fastercsv (1.5.5)
+    haml (4.0.7)
+      tilt
+    json (1.8.3)
+    json_pure (1.8.3)
+    multi_json (1.12.1)
+    public_suffix (2.0.4)
+    rack (1.6.5)
+    rack-protection (1.5.3)
+      rack
+    sinatra (1.4.7)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    stringex (1.5.1)
+    thin (1.7.0)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      rack (>= 1, < 3)
+    tilt (2.0.5)
+    uuidtools (2.1.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  data_mapper (~> 1.2.0)
+  dm-sqlite-adapter (~> 1.2.0)
+  haml (~> 4.0.7)
+  patreon!
+  sinatra (~> 1.4.7)
+  thin (~> 1.1)
+
+BUNDLED WITH
+   1.13.6

data/example/sinatra/README.md

@@ -0,0 +1,13 @@
+# Patreon OAuth Example: Sinatra Server
+
+Simple website made with Sinatra and the Patreon OAuth API
+
+## Install
+
+1. `bundle install`
+2. Fill out `MyConfig` in `app.rb` with your client details
+
+## Running the Server
+
+1. `bundle exec ruby app.rb`
+2. Visit [http://localhost:4567](http://localhost:4567)

data/example/sinatra/app.rb

@@ -0,0 +1,19 @@
+require 'sinatra/base'
+
+class MyApp < Sinatra::Application
+  enable :sessions
+  set :session_secret, 'my app has a secret'
+end
+
+class MyConfig
+  # Fill all this out with your information
+  PATREON_CLIENT_ID = nil
+  PATREON_CLIENT_SECRET = nil
+  PATREON_CREATOR_ID = nil
+  PATREON_REDIRECT_URI = nil
+end
+
+require_relative 'models/table/init'
+require_relative 'routes/init'
+
+MyApp.run! if MyApp.app_file == $0

data/example/sinatra/models/manager/patreon_user_mgr.rb

@@ -0,0 +1,40 @@
+require 'patreon'
+
+class PatreonUserManager
+  def self.create_or_update_user_with_tokens(patreon_refresh_token, patreon_access_token)
+    # https://www.patreon.com/platform/documentation/oauth -- Step 4
+    # Use the tokens to fetch the Patreon profile and pledge data, saving it all to the db.
+
+    return nil unless patreon_refresh_token and patreon_access_token
+
+    # Make the API client with the patron's access token
+    api_client = Patreon::API.new(patreon_access_token)
+
+    # Get the patron's profile info and pledge amount
+    user_response = api_client.fetch_user()
+    patreon_user_data = user_response['data']
+    return nil unless patreon_user_data
+
+    # Find or make the user, and set their information using the API response
+    db_user = User.first_or_create({:patreon_user_id => patreon_user_data['id']})
+    db_user.update({
+      :full_name => patreon_user_data['attributes']['full_name'],
+      :email => patreon_user_data['attributes']['email'],
+      :patreon_refresh_token => patreon_refresh_token,
+      :patreon_access_token => patreon_access_token
+    })
+
+    # Find the user's pledge to us, and if they have one, update their pledge amount in our db
+    pledge = (user_response['included'] || []).find {|obj|
+      obj['type'] == 'pledge' and obj['relationships']['creator']['data']['id'] == MyConfig::PATREON_CREATOR_ID
+    }
+    if pledge
+      db_user.update({
+          :patreon_pledge_amount_cents => pledge['attributes']['amount_cents']
+      })
+    end
+
+    # Return the user we've made or updated
+    return db_user
+  end
+end

data/example/sinatra/models/table/init.rb

@@ -0,0 +1,8 @@
+require "data_mapper"
+
+DataMapper::setup(:default, "sqlite://#{Dir.pwd}/sqlite.db")
+
+require_relative 'user'
+
+DataMapper.finalize
+DataMapper.auto_upgrade!

data/example/sinatra/models/table/user.rb

@@ -0,0 +1,13 @@
+require "data_mapper"
+
+class User
+  include DataMapper::Resource
+
+  property :user_id, Serial
+  property :full_name, String
+  property :email, String
+  property :patreon_pledge_amount_cents, Integer
+  property :patreon_user_id, String
+  property :patreon_refresh_token, String
+  property :patreon_access_token, String
+end

data/example/sinatra/routes/auth.rb

@@ -0,0 +1,47 @@
+require_relative '../models/manager/patreon_user_mgr'
+require 'patreon'
+
+class MyApp < Sinatra::Application
+  get '/' do
+    # https://www.patreon.com/platform/documentation/oauth -- Step 1
+    # The landing page links to patreon.com/oauth2/authorize so the user can authorize this app to access their Patreon data.
+    @log_in_url = (
+        "https://www.patreon.com/oauth2/authorize" \
+        "?response_type=code" \
+        "&client_id=%{client_id}" \
+        "&redirect_uri=%{redirect_uri}"
+    ) % {
+        :client_id => MyConfig::PATREON_CLIENT_ID,
+        :redirect_uri => MyConfig::PATREON_REDIRECT_URI
+    }
+    haml :login
+  end
+
+  get '/oauth/redirect' do
+    # https://www.patreon.com/platform/documentation/oauth -- Step 2
+    # After authorizing this app to access their Patreon data, the user is redirected back here.
+
+    # https://www.patreon.com/platform/documentation/oauth -- Step 3
+    # Use the code provided as a query parameter to get the user's access token and refresh token
+    oauth_client = Patreon::OAuth.new(MyConfig::PATREON_CLIENT_ID, MyConfig::PATREON_CLIENT_SECRET)
+    tokens = oauth_client.get_tokens(params['code'], 'http://localhost:4567/oauth/redirect')
+
+    # https://www.patreon.com/platform/documentation/oauth -- Step 4
+    # Save off the user's tokens and fetch their Patreon data.
+    user = PatreonUserManager.create_or_update_user_with_tokens(
+      patreon_refresh_token=tokens['refresh_token'],
+      patreon_access_token=tokens['access_token']
+    )
+
+    # https://www.patreon.com/platform/documentation/oauth -- Step 5
+    # If the user signed in successfully, take them to their profile page.
+    halt 403 unless user
+    redirect to("/users/%{user_id}" % {:user_id => user.user_id})
+  end
+
+  get '/users/:user_id' do
+    @user = User.get(params['user_id'])
+    halt 404 unless @user
+    haml :profile
+  end
+end

data/example/sinatra/routes/init.rb

@@ -0,0 +1 @@
+require_relative 'auth'

data/example/sinatra/views/layout.haml

@@ -0,0 +1,9 @@
+!!! XML
+!!! 1.1
+%html(xmlns="http://www.w3.org/1999/xhtml")
+  %head
+    %meta(charset="UTF-8")
+    %title= "Patreon OAuth Example: Sinatra Server"
+  %body
+    %h1= "Patreon OAuth Example: Sinatra Server"
+    #content= yield

data/example/sinatra/views/login.haml

@@ -0,0 +1 @@
+%a(href=@log_in_url)= "Log In with Patreon"

data/example/sinatra/views/profile.haml

@@ -0,0 +1,11 @@
+%h2= "Logged In!"
+
+%dl
+  %dt= "Name"
+  %dd= @user.full_name
+
+  %dt= "Email"
+  %dd= @user.email
+
+  %dt= "Pledge Amount (in cents)"
+  %dd= @user.patreon_pledge_amount_cents

data/lib/patreon/api.rb

@@ -1,6 +1,7 @@
 require 'net/http'
 require 'cgi'
 require 'json'
+require 'json-api-vanilla'
 
 module Patreon
   class API
@@ -31,12 +32,11 @@ module Patreon
     private
 
     def get_json(suffix)
-      print "getting suffix #{suffix}"
-      url = URI.parse("https://api.patreon.com/oauth2/api/#{suffix}")
+      url = URI.parse("https://www.patreon.com/api/oauth2/api/#{suffix}")
       req = Net::HTTP::Get.new(url.to_s)
       req['Authorization'] = "Bearer #{@access_token}"
       res = Net::HTTP.start(url.host, url.port, :use_ssl => true) {|http| http.request(req)}
-      JSON.parse(res.body)
+      return JSON::Api::Vanilla.parse(res.body)
     end
   end
 end

data/lib/patreon/oauth.rb

@@ -30,11 +30,11 @@ module Patreon
     private
 
     def update_token(params)
-      url = URI.parse('https://api.patreon.com/oauth2/token')
+      url = URI.parse('https://www.patreon.com/api/oauth2/token')
       url.query = URI.encode_www_form(params)
       req = Net::HTTP::Post.new(url.to_s)
       res = Net::HTTP.start(url.host, url.port, :use_ssl => true) {|http| http.request(req)}
       JSON.parse(res.body)
     end
   end
-end
+end

data/patreon.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = "patreon"
-  gem.version       = "0.2.0"
+  gem.version       = "0.3.0"
   gem.authors       = ["Patreon"]
   gem.email         = ["david@patreon.com"]
   gem.description   = "Interact with the Patreon API via OAuth"
@@ -16,4 +16,6 @@ Gem::Specification.new do |gem|
   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"]
+
+  gem.add_runtime_dependency 'json-api-vanilla', '~> 1.0.1'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: patreon
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Patreon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-21 00:00:00.000000000 Z
-dependencies: []
+date: 2017-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-api-vanilla
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 description: Interact with the Patreon API via OAuth
 email:
 - david@patreon.com
@@ -18,9 +32,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - NOTICE
 - README.md
+- example/fetch_all_patrons.rb
+- example/sinatra/.gitignore
+- example/sinatra/Gemfile
+- example/sinatra/Gemfile.lock
+- example/sinatra/README.md
+- example/sinatra/app.rb
+- example/sinatra/models/manager/patreon_user_mgr.rb
+- example/sinatra/models/table/init.rb
+- example/sinatra/models/table/user.rb
+- example/sinatra/routes/auth.rb
+- example/sinatra/routes/init.rb
+- example/sinatra/views/layout.haml
+- example/sinatra/views/login.haml
+- example/sinatra/views/profile.haml
 - lib/patreon.rb
 - lib/patreon/api.rb
 - lib/patreon/oauth.rb
@@ -53,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Visit patreon.com/oauth2/documentation for more information.