rails-pinterest 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b7c50a6d58454c8af8c007c32231f3c3f874c31304e7465fc0675655cf69a3f
-  data.tar.gz: e2dc9227c4325527e2d5bdf64ea9892cd254c6428a8a925fb81b7e74d5329d39
+  metadata.gz: c1fc96a443db45b6ac15f51c8152b6e87145b1c6dacb58d5b465b2d8a69f8b82
+  data.tar.gz: 6ea256a6db07492035e6e622f4cb7e5617792ef3963ec7a1e452a9406a7279ef
 SHA512:
-  metadata.gz: 0d731a33f948dc774545d087740070623248974571187b5c25d2609cd71b2513ed457e4c820f9cea27e28de69ee8cc61c78dcc3e154328a098b630744381a866
-  data.tar.gz: 2790992016e2b563fb99146dbda1d737cf99e1115c2ceace8bd0d4b961027922357d3806e5265e63b78efc1961679fd0816a99cec161293995ed3c6f320459fe
+  metadata.gz: 12bad857ab4b1aec512620322dc720c0e04243537279cad50c5be6242208c2aa3a264ef0ac82cbd87892da2f5276a7d7993f501d0fdac397718e0a0a580653a8
+  data.tar.gz: 8c3a3ac50db6366fa37df5d5aacff6d8e556aa6545bbb7350c650ceb7096efa8999869427c7798773b7022cb559183f230167490330d4c6422d473ea2f355db7

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 ## [Unreleased]
 
-## [0.1.0] - 2023-10-01
+## [0.1.0] - 2023-11-30
 
 - Initial release
-- Endpoints for Pins and Boards created
+- Endpoints for Pins and Boards created
+
+## [0.1.1] - 2023-11-30
+- Update the gemfile.lock
+- Push the tagged version to github
+- Re-release to rubygems
+
+## [0.1.2] - 2023-12-2
+- Added oauth refresh token endpoint.
+
+## [0.1.3] - 2023-12-2
+- Add to ReadMe how to get access token from a authorization token

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails-pinterest (0.1.1)
+    rails-pinterest (0.1.3)
       faraday (>= 1)
       faraday-multipart (>= 1)
 

data/README.md

@@ -174,6 +174,69 @@ response = client.pins.create_pin(parameters: parameters)
 
 ```
 
+### Oauth
+
+How to get exchange your authorization code for an access token [(step 3)](https://developers.pinterest.com/docs/getting-started/authentication/)
+```ruby
+# https://developers.pinterest.com/docs/getting-started/authentication/
+
+# POST /oauth/tokens to exchange authorization code for access token
+
+# 1. Build the client
+client = Pinterest::Client.new(access_token: "fake-token-because-you-dont-have-this-yet", client_id: "client-id" , secret_key: "secret-key")
+
+# 2. Build parameters
+parameters = {
+  'grant_type'    => 'authorization_code', # Required from Pinterest
+  'code'          => params[:code].to_s, # Replace with the actual authorization code
+  'redirect_uri'  => "your-redirect-uri"
+}
+
+# 3. Get the access token
+response = client.oauth.retrieve_oauth_token(parameters: parameters)
+puts response
+# { "access_token": "{an access token string prefixed with 'pina'}", "refresh_token": "{a refresh token string prefixed with 'pinr'}", "response_type": "authorization_code", ..
+
+```
+
+How to refresh your access tokens
+
+```ruby
+# https://developers.pinterest.com/docs/api/v5/#tag/oauth
+
+# POST /oauth/tokens to refresh tokens
+parameters = {
+    refresh_token: "your-refresh-token-goes-here", 
+    grant_type: 'refresh_token' # Keep it as 'refresh_token' as per Pinterest API requirements
+    scope: 'whatever-new-scopes-desired' #optional
+}
+response = client.oauth.retrieve_oauth_token(parameters: parameters)
+puts response
+# { "response_type": "refresh_token", "access_token": "string", "token_type": "bearer", "expires_in": 0, "scope": "string" }
+
+```
+
+Running the Oauth Refresh Token in Console
+```ruby
+# https://developers.pinterest.com/docs/api/v5/#tag/oauth
+
+# 1. Create the client
+client = Pinterest::Client.new(refresh_token: "your-refresh-token", access_token: "can-be-any-fake-or-real-token", client_id: 'client-id-or-app-id' , secret_key: "secret-key")
+
+# 2. Set up the params
+parameters = {
+    refresh_token: "your-refresh-token-goes-here", 
+    grant_type: 'refresh_token' # Keep it as 'refresh_token' as per Pinterest API requirements
+    scope: 'whatever-new-scopes-desired' #optional
+}
+
+# 3. Retrieve refreshed access_token
+response = client.oauth.retrieve_oauth_token(parameters: parameters)
+puts response
+# { "response_type": "refresh_token", "access_token": "string", "token_type": "bearer", "expires_in": 0, "scope": "string" }
+
+```
+**NOTE:** This is likely how you'll be doing it if you manage multiple Pinterest Apps for users in your web/mobile app. Because you'll have multiple access_tokens and refresh_tokens, you can't have this in an .env configuration. You'll likely create new clients every time you refresh with your users' or customers' saved access/refresh_tokens.
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/pinterest/client.rb

@@ -6,6 +6,9 @@ module Pinterest
       api_type
       api_version
       access_token
+      refresh_token
+      client_id
+      secret_key
       uri_base
       request_timeout
       extra_headers
@@ -27,5 +30,9 @@ module Pinterest
     def pins
       @pins ||= Pinterest::Pins.new(client: self)
     end
+
+    def oauth
+      @oauth ||= Pinterest::Oauth.new(client: self)
+    end
   end
 end

data/lib/pinterest/http.rb

@@ -34,6 +34,14 @@ module Pinterest
       end&.body)
     end
 
+    def oauth_post(path:, parameters:)
+      response = oauth_conn.post(uri(path: path)) do |req|
+        req.headers = oauth_headers
+        req.body = parameters
+      end
+      response
+    end
+
     private
 
     def to_json(string)
@@ -52,6 +60,14 @@ module Pinterest
       end
     end
 
+    def oauth_conn(multipart: false)
+      Faraday.new do |f|
+        f.options[:timeout] = @request_timeout
+        f.request :url_encoded
+        f.adapter Faraday.default_adapter
+      end
+    end
+
     def uri(path:)
       File.join(@uri_base, @api_version, path)
     end
@@ -67,6 +83,15 @@ module Pinterest
       }
     end
 
+    def oauth_headers
+      token = Base64.encode64("#{@client_id}:#{@secret_key}").gsub("\n", '')
+      puts "Token: #{token}"
+      {
+        "Authorization" => "Basic #{token}",
+        "Content-Type" => "application/x-www-form-urlencoded",
+      }
+    end
+
     def multipart_parameters(parameters)
       parameters&.transform_values do |value|
         next value unless value.respond_to?(:close) # File or IO object.

data/lib/pinterest/oauth.rb

@@ -0,0 +1,11 @@
+module Pinterest
+  class Oauth
+    def initialize(client: nil)
+      @client = client
+    end  
+
+    def retrieve_oauth_token(parameters: {})
+      @client.oauth_post(path: "/oauth/token", parameters: parameters)
+    end
+  end
+end

data/lib/pinterest/version.rb

@@ -1,3 +1,3 @@
 module Pinterest
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/pinterest.rb

@@ -3,6 +3,7 @@ require "faraday/multipart"
 require_relative "pinterest/http"
 require_relative "pinterest/client"
 require_relative "pinterest/boards"
+require_relative "pinterest/oauth"
 require_relative "pinterest/pins"
 require_relative "pinterest/version"
 
@@ -13,7 +14,7 @@ module Pinterest
   class Configuration
     attr_writer :access_token
     attr_accessor :api_type, :api_version, :uri_base, :request_timeout,
-                  :extra_headers
+                  :extra_headers, :refresh_token, :client_id, :secret_key
 
     DEFAULT_API_VERSION = "v5".freeze
     DEFAULT_URI_BASE = "https://api.pinterest.com/".freeze
@@ -22,6 +23,9 @@ module Pinterest
     def initialize
       @access_token = nil
       @api_type = nil
+      @refresh_token = nil
+      @client_id = nil
+      @secret_key = nil
       @api_version = DEFAULT_API_VERSION
       @uri_base = DEFAULT_URI_BASE
       @request_timeout = DEFAULT_REQUEST_TIMEOUT
@@ -34,7 +38,7 @@ module Pinterest
     def access_token
       return @access_token if @access_token
 
-      error_text = "Pinterest access token missing! See https://github.com/alexrudall/ruby-openai#usage"
+      error_text = "Pinterest access token missing!"
       raise ConfigurationError, error_text
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pinterest
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Donald Lee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-01 00:00:00.000000000 Z
+date: 2023-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -60,6 +60,7 @@ files:
 - lib/pinterest/client.rb
 - lib/pinterest/compatibility.rb
 - lib/pinterest/http.rb
+- lib/pinterest/oauth.rb
 - lib/pinterest/pins.rb
 - lib/pinterest/version.rb
 - lib/ruby/pinterest.rb