pinterest-api 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23947737fa04298dcb3b66c9ce5859e072ce6c05
-  data.tar.gz: 58e70ea1325e5a89b08655f5816623c04ae27584
+  metadata.gz: b0d81e04ec50f94410f1d1bc014bc6ee1343f3e2
+  data.tar.gz: 57d301ff4fd4b41ad507b2e892d8d1c45b6956d5
 SHA512:
-  metadata.gz: c59be570e75c7621ddf28fc114a6f41379b183bdbdc06ee7785a400da7ef88377fba90a2e7fb3bcddefdde2c27971743e36fa6db9b0dddc21ba7a1b7a0defc7d
-  data.tar.gz: 292bd49abfedb82e14112704c861d54b9b08ee92e9d7370f64c41619b0e51e8cb04220fdb020eddfb1c89ee71932368fdd4d893dbfc8b2827fcc88cea883bc11
+  metadata.gz: a259c40135f8d701451825b2b914c481c3a0bd60ab2fbd9c66ffdab7047d199e05ac84c4f262ba0f87f29f3ffe7a9abb5b43d9781e2c8687852962c7f8416de1
+  data.tar.gz: f43ddf762cbef6077258940e5efca3f1acff9c47eae2b5bc176bf80fc1f330451246fe5694bed46d6b920615c453cab8a2d89ef968f65685010ffca24a15e3e4

data/.gitignore

@@ -9,3 +9,5 @@
 /tmp/
 .env
 *.gem
+*.swp
+*.swo

data/README.md

@@ -2,12 +2,13 @@
 
 [![Gem Version](https://badge.fury.io/rb/pinterest-api.svg)](https://badge.fury.io/rb/pinterest-api)  
 [![Code Climate](https://codeclimate.com/github/realadeel/pinterest-api/badges/gpa.svg)](https://codeclimate.com/github/realadeel/pinterest-api)
-[![Build Status](https://semaphoreci.com/api/v1/projects/17e4870c-9339-42e9-b2a1-8a7ca1d02bc2/558393/badge.svg)](https://semaphoreci.com/realdeal/pinterest-api)
 
 This is the Ruby gem for interacting with the official [Pinterest REST API](https://developers.pinterest.com/docs/getting-started/introduction/).  
 
 This gem uses Faraday and Hashie to make requests and parse the responses.
 
+Battle-tested at [Shopseen](https://www.shopseen.com) to help merchants sell more.
+
 ## Usage
 
 Obtain an access token from Pinterest. You can generate one [here](https://developers.pinterest.com/tools/access_token/).
@@ -50,11 +51,19 @@ client.follow_board(<board_id>)
 client.unfollow_board(<board_id>)
 
 # Follow an interest
+> This endpoint is no longer part of the Pinterest documentation, and has always returned an error
 client.follow_interest(<interest_id>)
 
 # Unfollow an interest
+> This endpoint is no longer part of the Pinterest documentation, and has always returned an error
 client.unfollow_interest(<interest_id>)
 
+# Get all of authenticated users's pins
+client.get_pins  
+
+# Get all of authenticated users's boards
+client.get_boards
+
 # Search for authenticated users's pins related to shoes
 client.get_pins(query: 'shoes')  
 
@@ -64,6 +73,29 @@ client.get_boards(query: 'shoes')
 # Get the account info for a Pinterest user
 client.get_user('<username>')
 
+```
+## Creating pins
+
+You can create pins as follows
+
+```
+@client.create_pin({
+  board: '<username>/<board_name>' OR '<board_id>',
+  note: 'My note'
+  link: 'https://www.google.com',
+  image_url: 'http://marketingland.com/wp-content/ml-loads/2014/07/pinterest-logo-white-1920.png'
+})
+```
+
+You can also upload your own image file like so
+
+```
+@client.create_pin({
+  board: '1154178055932271277',
+  note: 'Test from ruby gem',
+  link: 'https://www.shopseen.com',
+  image: Faraday::UploadIO.new(your_file_path, "image/<image_type>")
+})
 ```
 
 ## Authentication
@@ -91,6 +123,23 @@ OAuth values from Pinterest in ```request.env['omniauth.auth']```
 For more details, check out "Integrating OmniAuth Into Your Application"  
 https://github.com/intridea/omniauth
 
+## Request options
+
+You can set any request options that are valid in `Faraday::Connection` by adding them as a has to the Pinterest Client initializer.
+
+Example:
+
+```
+  client = Pinterest::Client.new(ACCESS_TOKEN, {
+    request: {
+      timeout: 1.5,
+      open_timeout: 1,
+    }
+  })
+
+  counts = client.get_user('<username>', {fields: "counts"})
+```
+
 ## Known Issues
 
 The gem is currently under active development. The following issues cause the test specs to fail, though it's not clear to me that these issues are not with the Pinterest API itself.  

data/lib/pinterest/client.rb

@@ -14,8 +14,9 @@ module Pinterest
     DEFAULT_USER_AGENT = "Pinterest Ruby Gem #{Pinterest::VERSION}".freeze
     DEFAULT_ADAPTER = Faraday.default_adapter
 
-    def initialize(access_token = nil)
+    def initialize(access_token = nil, connection_options={})
       @access_token = access_token
+      @connection_options = connection_options
     end
 
     attr_reader :access_token
@@ -51,6 +52,10 @@ module Pinterest
         when :get
           path = path + "?access_token=" + @access_token
           request.url(URI.encode(path), options)
+        when :patch
+          request.path = path + "?access_token=" + @access_token
+          request.body = options unless options.empty?
+          request.headers['Authorization'] = "BEARER #{@access_token}"
         when :post, :put, :delete
           request.path = URI.encode(path)
           request.body = options unless options.empty?
@@ -61,15 +66,16 @@ module Pinterest
     end
 
     def connection(raw = false, log = false)
-      options = {
+      options = @connection_options.merge({
         :headers => {'Accept' => "application/json; charset=utf-8", 'User-Agent' => user_agent},
         :url => endpoint,
-      }
+      })
 
       Faraday::Connection.new(options) do |connection|
         unless raw
           connection.use FaradayMiddleware::Mashify
         end
+        connection.use Faraday::Request::Multipart
         connection.use Faraday::Response::ParseJson
         connection.use Faraday::Request::UrlEncoded
         connection.response :logger if log

data/lib/pinterest/client/pin.rb

@@ -14,8 +14,8 @@ module Pinterest
         post('pins', params)
       end
 
-      def update_pin(params={})
-        patch('pins', params)
+      def update_pin(id, params={})
+        patch("pins/#{id}", params)
       end
 
       def delete_pin(id)

data/lib/pinterest/version.rb

@@ -1,3 +1,3 @@
 module Pinterest
-  VERSION = "0.2.2"
+  VERSION = "0.4.0"
 end

data/pinterest.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.3"
   spec.add_development_dependency "vcr", "~> 2.9"
   spec.add_development_dependency "dotenv", "~> 2.0"
-  spec.add_development_dependency "webmock", "~> 1.0"
+  spec.add_development_dependency "webmock", "~> 3.0.1"
 
   spec.add_dependency 'faraday', "~> 0.9"
   spec.add_dependency 'faraday_middleware', "~> 0.9"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pinterest-api
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Adeel Ahmad
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-12 00:00:00.000000000 Z
+date: 2017-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 3.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 3.0.1
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -209,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Ruby gem to interact with the Pinterest REST API