{"repo":"Patreon/patreon-ruby","free":true,"listed":false,"github":"https://github.com/Patreon/patreon-ruby","clone":"git clone https://github.com/Patreon/patreon-ruby.git","description":"Interact with the Patreon API via OAuth","language":"Ruby","stars":37,"topics":["patreon","oauth"],"license":"Apache-2.0","category":"auth-billing-email","readme_excerpt":"patreon-ruby [!CAUTION] This package is deprecated. It uses Patreon API v1, which is deprecated and no longer maintained. This SDK will not receive further updates. We recommend migrating to the Patreon API v2 by integrating directly using your own HTTP client. See the API documentation and v1 to v2 migration overview for details. --- Interact with the Patreon API via OAuth. Get the gem from RubyGems Step 1. Get your client id and client secret --- Visit the OAuth Documentation Page while logged in as a Patreon creator to register your client. This will provide you with a client id and a client secret . Step 2. Use this library e.g. the example Sinatra app in this repo or the Rails route example below. --- Step 3. (Optional) Customize your usage --- Patreon::API instances have four methods: fetch user(includes=nil, fields=nil) fetch campaign(includes=nil, fields=nil) fetch campaign and patrons(includes=nil, fields=nil) fetch page of pledges(campaign id, page size, cursor=nil, includes=nil, fields=nil) The includes and fields arguments to these methods specify the related resources and the resource attributes you want returned by our API, as per the JSON:API specification. The lists of valid includes and fields arguments are provided on Patreon::Schemas . For instance, if you wanted to request the total amount a patron has ever paid to your campaign, which is not included by default, you could do:","default_branch":null,"files":null,"tree":[],"storefront":"/r/Patreon","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Patreon/patreon-ruby/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}