rails-pinterest 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acea05888eb1f4e066d2ccd569c06247dafcc2017c6d00ce8ca8d6ba09123e79
-  data.tar.gz: 34f53ac40b094a888c2a2ddde8ebe4b21c6abe012a262e60ad337c3257607ad2
+  metadata.gz: c2511d23d52e43b2316914cd9ae42d5420a9677471f417c3d725c36c58abaabe
+  data.tar.gz: 17ca93046f01b103c386a01fcf3048da5736f14168cb6f9e27ddb4a3f554d5e9
 SHA512:
-  metadata.gz: aa1d8f190e023964ee127492199ea371d27a9c4701f6cd15d152ff16fcfe2cdafc3d33d81b132fff78eaf9862063943f6d6f5f30e6bf0080cf97024f73adfde9
-  data.tar.gz: 7a1019812589c76673aee7ebd408dc2496dc8b31cbbb2665d42c72824cfa46b84661b22a78327698f17d029f74858a226d4b2d5fe5b2d14c2ddce3c9b5fc6037
+  metadata.gz: dd55a3c51bb89ea98999bc7b9c11c79aeb2fc5ba03f9fbc0fe69dcc4b0fd2156725a57261fea987450329e7242c4841c820c300a290f04f3db11ca9104fc4a9a
+  data.tar.gz: 2cff0ae0bfe401e66c8445f8aef9222576c69d6227f05b2e229e9c043df2129b36bb1e71f43545e8b2f6ac4874135b2d0f73b4c89d22e92a9557a4de92b4c1e1

data/CHANGELOG.md

@@ -44,4 +44,21 @@
 - Fix param requirement for Media#register_media_upload
 
 ## [0.2.3] - 2024-03-11
-- Revert V.0.2.3
+- Revert V.0.2.3
+
+## [0.2.4] - 2024-04-09
+- Add User Account to API
+
+## [0.2.5] - 2024-05-10
+- Add the beta endpoint https://developer.pinterest.com/docs/api/v5/#operation/multi_pins/analytics (it doesn't really work right now)
+- Example usage:
+```ruby
+client = Pinterest::Client.new(access_token: "some-access-token")
+params = {
+    pin_ids: ["920634348815764178","920634348815790715","920634348815829069","920634348815865049","920634348815897303","920634348815911959","920634348815943797","920634348816238458","920634348816183143","920634348816403644","920634348816488886","920634348816699966"],
+    start_date: "2024-03-01",
+    end_date: "2024-05-10",
+    metric_types: ["IMPRESSION", "OUTBOUND_CLICK", "PIN_CLICK", "SAVE", "SAVE_RATE", "VIDEO_MRC_VIEW", "VIDEO_10S_VIEW", "QUARTILE_95_PERCENT_VIEW", "VIDEO_V50_WATCH_TIME", "VIDEO_START", "VIDEO_AVG_WATCH_TIME", "TOTAL_COMMENTS", "TOTAL_REACTIONS"]
+}
+response = client.pins.get_multiple_pin_analytics(ids: params[:pin_ids], start_date: params[:start_date], end_date: params[:end_date], metric_types: params[:metric_types], parameters: {})
+```

data/Gemfile.lock

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

data/README.md

@@ -260,4 +260,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 Everyone interacting in the Ruby Pinterest project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/royalgiant/rails-pinterest/blob/main/CODE_OF_CONDUCT.md).
 
 ## Influences
-Project heavily influenced by [https://github.com/alexrudall/ruby-openai](https://github.com/alexrudall/ruby-openai). Great project, go give them a star!
+Project heavily influenced by [https://github.com/alexrudall/ruby-openai](https://github.com/alexrudall/ruby-openai). Great project, go give them a star!
+
+## Where Is Rails-Pinterest Used?
+Currently used by [Imagifyr](https://imagifyr.com) to allow creators to schedule their content. SEO Optimized with AI.

data/lib/pinterest/client.rb

@@ -46,5 +46,9 @@ module Pinterest
     def media
       @media ||= Pinterest::Media.new(client: self)
     end
+
+    def user_account
+      @user_account ||= Pinterest::UserAccount.new(client: self)
+    end
   end
 end

data/lib/pinterest/pins.rb

@@ -24,8 +24,12 @@ module Pinterest
       @client.patch(path: "/pins/#{id}", parameters: parameters)
     end
 
-    def get_pin_analytics(id:, parameters: {})
-      @client.get(path: "/pins/#{id}/analytics", parameters: parameters)
+    def get_pin_analytics(id:, start_date:, end_date:, metric_types:, parameters: {})
+      @client.get(path: "/pins/#{id}/analytics?start_date=#{start_date}&end_date=#{end_date}&metric_types=#{metric_types}", parameters: parameters)
+    end
+
+    def get_multiple_pin_analytics(ids:, start_date:, end_date:, metric_types:, parameters: {})
+      @client.get(path: "/pins/analytics?pin_ids=#{ids}&start_date=#{start_date}&end_date=#{end_date}&metric_types=#{metric_types}", parameters: parameters)
     end
 
     def save_pin(id: , parameters: {})

data/lib/pinterest/user_account.rb

@@ -0,0 +1,144 @@
+module Pinterest
+    class UserAccount
+      def initialize(client: nil)
+        @client = client
+      end
+  
+      def get_user_account(parameters: {})
+        @client.get(path: "/user_account", parameters: parameters)
+      end
+
+      def get_user_account_analytics(start_date:, end_date:, parameters: {})
+        query_string = "/user_account/analytics?start_date=#{start_date}&end_date=#{end_date}"
+        if parameters[:from_claimed_content] && !parameters[:from_claimed_content].empty?
+          query_string += "&from_claimed_content=#{parameters[:from_claimed_content]}"
+        end
+        if parameters[:pin_format] && !parameters[:pin_format].empty?
+          query_string += "&pin_format=#{parameters[:pin_format]}"
+        end
+        if parameters[:app_types] && !parameters[:app_types].empty?
+          query_string += "&app_types=#{parameters[:app_types]}"
+        end
+        if parameters[:content_type] && !parameters[:content_type].empty?
+          query_string += "&content_type=#{parameters[:content_type]}"
+        end
+        if parameters[:source] && !parameters[:source].empty?
+          query_string += "&source=#{parameters[:source]}"
+        end
+        if parameters[:metric_types] && !parameters[:metric_types].empty?
+          query_string += "&metric_types=#{parameters[:metric_types]}"
+        end
+        if parameters[:split_field] && !parameters[:split_field].empty?
+          query_string += "&split_field=#{parameters[:split_field]}"
+        end
+        if parameters[:ad_account_id] && !parameters[:ad_account_id].empty?
+          query_string += "&ad_account_id=#{parameters[:ad_account_id]}"
+        end
+        @client.get(path: query_string, parameters: parameters)
+      end
+  
+      def get_user_account_top_pins_analytics(start_date:, end_date:, sort_by:, parameters: {})
+        query_string = "/user_account/analytics?start_date=#{start_date}&end_date=#{end_date}&sort_by=#{sort_by}"
+        if parameters[:from_claimed_content] && !parameters[:from_claimed_content].empty?
+          query_string += "&from_claimed_content=#{parameters[:from_claimed_content]}"
+        end
+        if parameters[:pin_format] && !parameters[:pin_format].empty?
+          query_string += "&pin_format=#{parameters[:pin_format]}"
+        end
+        if parameters[:app_types] && !parameters[:app_types].empty?
+          query_string += "&app_types=#{parameters[:app_types]}"
+        end
+        if parameters[:content_type] && !parameters[:content_type].empty?
+          query_string += "&content_type=#{parameters[:content_type]}"
+        end
+        if parameters[:source] && !parameters[:source].empty?
+          query_string += "&source=#{parameters[:source]}"
+        end
+        if parameters[:metric_types] && !parameters[:metric_types].empty?
+          query_string += "&metric_types=#{parameters[:metric_types]}"
+        end
+        if parameters[:num_of_pins] && !parameters[:num_of_pins].empty?
+          query_string += "&num_of_pins=#{parameters[:num_of_pins]}"
+        end
+        if parameters[:created_in_last_n_days] && !parameters[:created_in_last_n_days].empty?
+          query_string += "&created_in_last_n_days=#{parameters[:created_in_last_n_days]}"
+        end
+        if parameters[:ad_account_id] && !parameters[:ad_account_id].empty?
+          query_string += "&ad_account_id=#{parameters[:ad_account_id]}"
+        end
+        @client.get(path: query_string, parameters: parameters)
+      end
+      
+      def get_user_account_top_video_pins_analytics(start_date:, end_date:, sort_by:, parameters: {})
+        query_string = "/user_account/analytics?start_date=#{start_date}&end_date=#{end_date}&sort_by=#{sort_by}"
+        if parameters[:from_claimed_content] && !parameters[:from_claimed_content].empty?
+          query_string += "&from_claimed_content=#{parameters[:from_claimed_content]}"
+        end
+        if parameters[:pin_format] && !parameters[:pin_format].empty?
+          query_string += "&pin_format=#{parameters[:pin_format]}"
+        end
+        if parameters[:app_types] && !parameters[:app_types].empty?
+          query_string += "&app_types=#{parameters[:app_types]}"
+        end
+        if parameters[:content_type] && !parameters[:content_type].empty?
+          query_string += "&content_type=#{parameters[:content_type]}"
+        end
+        if parameters[:source] && !parameters[:source].empty?
+          query_string += "&source=#{parameters[:source]}"
+        end
+        if parameters[:metric_types] && !parameters[:metric_types].empty?
+          query_string += "&metric_types=#{parameters[:metric_types]}"
+        end
+        if parameters[:num_of_pins] && !parameters[:num_of_pins].empty?
+          query_string += "&num_of_pins=#{parameters[:num_of_pins]}"
+        end
+        if parameters[:created_in_last_n_days] && !parameters[:created_in_last_n_days].empty?
+          query_string += "&created_in_last_n_days=#{parameters[:created_in_last_n_days]}"
+        end
+        if parameters[:ad_account_id] && !parameters[:ad_account_id].empty?
+          query_string += "&ad_account_id=#{parameters[:ad_account_id]}"
+        end
+        @client.get(path: query_string, parameters: parameters)
+      end
+
+      def list_linked_businesses(parameters: {})
+        @client.get(path: "/user_account/businesses", parameters: parameters)
+      end
+
+      def list_followers(parameters: {})
+        @client.get(path: "/user_account/followers", parameters: parameters)
+      end
+
+      def list_following(parameters: {})
+        @client.get(path: "/user_account/following", parameters: parameters)
+      end
+
+      def list_following_boards(parameters: {})
+        @client.get(path: "/user_account/following/boards", parameters: parameters)
+      end
+
+      def follow_user(username:, parameters: {})
+        @client.json_post(path: "/user_account/following/#{username}", parameters: parameters)
+      end
+
+      def verify_website(parameters: {})
+        @client.json_post(path: "/user_account/websites", parameters: parameters)
+      end
+
+      def get_user_websites(parameters: {})
+        @client.get(path: "/user_account/websites", parameters: parameters)
+      end
+
+      def unverify_website(website:)
+        @client.delete(path: "/user_account/websites?website=#{website}")
+      end
+
+      def get_user_verification_code_for_website_claiming(parameters: {})
+        @client.get(path: "/user_account/websites/verification", parameters: parameters)
+      end
+
+      def list_following_interests(username:, parameters: {})
+        @client.get(path: "/users/#{username}/interests/follow", parameters: parameters)
+      end
+    end
+  end

data/lib/pinterest/version.rb

@@ -1,3 +1,3 @@
 module Pinterest
-  VERSION = "0.2.3"
+  VERSION = "0.2.5"
 end

data/lib/pinterest.rb

@@ -8,6 +8,7 @@ require_relative "pinterest/media"
 require_relative "pinterest/oauth"
 require_relative "pinterest/pins"
 require_relative "pinterest/terms"
+require_relative "pinterest/user_account"
 require_relative "pinterest/version"
 
 module Pinterest

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pinterest
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.5
 platform: ruby
 authors:
 - Donald Lee
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-12 00:00:00.000000000 Z
+date: 2024-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -65,6 +65,7 @@ files:
 - lib/pinterest/oauth.rb
 - lib/pinterest/pins.rb
 - lib/pinterest/terms.rb
+- lib/pinterest/user_account.rb
 - lib/pinterest/version.rb
 - lib/ruby/pinterest.rb
 - rails-pinterest.gemspec