pinterest-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62f3ada09f30718758f52b7d1d117b3fff499df7
+  data.tar.gz: 2e8a9a59ac855f76a9ecb7477cb7aecd8582a4fd
+SHA512:
+  metadata.gz: c39ecfaf4a9a4e59af34b0a2025721e4ece28cc180a14c1153b414d30639a89f7c29998ee524edf903c82b5d6f09e296d22b3a4e6273990c3935e413e5e10e03
+  data.tar.gz: 2e5247eb424861dc70229bbfaf55d9d9f4f22f4ac431db9fdcee9cd7cf9379dd3a2356a046db850eb5814ed03695ae9899fb8b8b8cf5fbd9bd92e5abd9049ccf

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pinterest.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Adeel Ahmad
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,83 @@
+# Pinterest
+
+[![Code Climate](https://codeclimate.com/github/realadeel/pinterest-api/badges/gpa.svg)](https://codeclimate.com/github/realadeel/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.
+
+## Usage
+
+Obtain an access token from Pinterest. You can generate one [here](https://developers.pinterest.com/docs/api/access_token/).
+
+$ gem install pinterest
+
+```ruby
+require 'pinterest-api'
+
+client = Pinterest::Client.new(ACCESS_TOKEN)
+
+# Get the authenticated user's Pinterest account info
+client.me
+
+# Get the pins that the authenticated user likes
+client.get_likes
+
+# Get the authenticated user's followers
+client.get_followers
+
+# Get the boards that the authenticated user follows
+client.get_followed_boards
+
+# Get the Pinterest users that the authenticated user follows
+client.get_followed_users
+
+# Get the interests that the authenticated user follows
+client.get_followed_interests
+
+# Follow a user
+client.follow_user('shopseen')
+
+# Unfollow a user
+client.unfollow_user('shopseen')
+
+# Follow a board
+client.follow_board(<board_id>)
+
+# Unfollow a board
+client.unfollow_board(<board_id>)
+
+# Follow an interest
+client.follow_interest(<interest_id>)
+
+# Unfollow an interest
+client.unfollow_interest(<interest_id>)
+
+# Search for authenticated users's pins related to shoes
+client.get_pins(query: 'shoes')  
+
+# Search for authenticated users's boards related to shoes
+client.get_boards(query: 'shoes')
+
+# Get the account info for a Pinterest user
+client.get_user('<username>')
+
+```
+
+The gem is currently under active development. Use at your own risk. See Known Issues below.  
+I hope to have the gem ready for production shortly. See Contributing section below to help.  
+
+## Known Issues
+
+* PATCH requests not working, endpoint path is not being appended to base
+
+## TODO
+
+* Pagination
+* OAuth
+* document Mash response methods
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/realadeel/pinterest-api.  
+Please provide a failing test for bug reports, and a passing test for pull requests.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pinterest"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pinterest-api.rb

@@ -0,0 +1,6 @@
+require "pinterest/version"
+require "pinterest/client"
+
+module Pinterest
+
+end

data/lib/pinterest/client.rb

@@ -0,0 +1,93 @@
+require 'faraday_middleware'
+require 'pinterest/client/user'
+require 'pinterest/client/pin'
+require 'pinterest/client/board'
+
+module Pinterest
+  class Client
+
+    include Pinterest::Client::User
+    include Pinterest::Client::Pin
+    include Pinterest::Client::Board
+
+    BASE_ENDPOINT = 'https://api.pinterest.com/v1/'.freeze
+    DEFAULT_USER_AGENT = "Pinterest Ruby Gem #{Pinterest::VERSION}".freeze
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    def initialize(access_token = nil)
+      @access_token = access_token
+    end
+
+    attr_reader :access_token
+
+    def get(path, options={})
+      request(:get, path, options)
+    end
+
+    def post(path, options={})
+      request(:post, path, options)
+    end
+
+    def patch(path, options={})
+      request(:patch, path, options)
+    end
+
+    def put(path, options={})
+      request(:put, path, options)
+    end
+
+    def delete(path, options={})
+      request(:delete, path, options)
+    end
+
+    private
+
+    def request(method, path, options)
+      raw = options.delete(:raw)
+      log = options.delete(:log)
+      path = File.join(path, '')
+      response = connection(raw, log).send(method) do |request|
+        case method
+        when :get
+          path = path + "?access_token=" + @access_token
+          request.url(URI.encode(path), options)
+        when :post, :put, :delete
+          request.path = URI.encode(path)
+          request.body = options unless options.empty?
+          request.headers['Authorization'] = "BEARER #{@access_token}"
+        end
+      end
+      return response.body
+    end
+
+    def connection(raw = false, log = false)
+      options = {
+        :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::Response::ParseJson
+        connection.use Faraday::Request::UrlEncoded
+        connection.response :logger if log
+        connection.adapter(adapter)
+      end
+    end
+
+    def endpoint
+      BASE_ENDPOINT
+    end
+
+    def user_agent
+      DEFAULT_USER_AGENT
+    end
+
+    def adapter
+      DEFAULT_ADAPTER
+    end
+
+  end
+end

data/lib/pinterest/client/board.rb

@@ -0,0 +1,23 @@
+module Pinterest
+  class Client
+    module Board
+
+      def get_board(id)
+        get("boards/#{id}")
+      end
+
+      def create_board(params={})
+        post('boards', params)
+      end
+
+      def update_board(params={})
+        patch('boards', params)
+      end
+
+      def delete_board(id)
+        delete("boards/#{id}")
+      end
+
+    end
+  end
+end

data/lib/pinterest/client/pin.rb

@@ -0,0 +1,27 @@
+module Pinterest
+  class Client
+    module Pin
+
+      def get_pin(id)
+        get("pins/#{id}")
+      end
+
+      def get_board_pins(board_id)
+        get("boards/#{board_id}/pins")
+      end
+
+      def create_pin(params={})
+        post('pins', params)
+      end
+
+      def update_pin(params={})
+        patch('pins', params)
+      end
+
+      def delete_pin(id)
+        delete("pins/#{id}")
+      end
+
+    end
+  end
+end

data/lib/pinterest/client/user.rb

@@ -0,0 +1,67 @@
+module Pinterest
+  class Client
+    module User
+
+      def me
+        get('me')
+      end
+
+      def get_followers
+        get("me/followers")
+      end
+
+      def get_likes
+        get("me/likes")
+      end
+
+      def get_followed_boards
+        get("me/following/boards")
+      end
+
+      def get_followed_users
+        get("me/following/users")
+      end
+
+      def get_followed_interests
+        get("me/following/interests")
+      end
+
+      def follow_user(user)
+        post('me/following/users', user: user)
+      end
+
+      def unfollow_user(user)
+        delete("me/following/users/#{user}")
+      end
+
+      def follow_board(board_id)
+        post('me/following/boards', board: board_id)
+      end
+
+      def unfollow_board(board_id)
+        delete("me/following/boards/#{board_id}")
+      end
+
+      def follow_interest(interest_id)
+        post('me/following/interests', interest: interest_id)
+      end
+
+      def unfollow_interest(interest_id)
+        delete("me/following/interests/#{interest_id}")
+      end
+
+      def search_pins(params={})
+        get('me/search/pins', query: params[:query])
+      end
+
+      def search_boards(params={})
+        get('me/search/boards', query: params[:query])
+      end
+
+      def get_user(user)
+        get("users/#{user}")
+      end
+
+    end
+  end
+end

data/lib/pinterest/version.rb

@@ -0,0 +1,3 @@
+module Pinterest
+  VERSION = "0.1.0"
+end

data/pinterest.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pinterest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pinterest-api"
+  spec.version       = Pinterest::VERSION
+  spec.authors       = ["Adeel Ahmad"]
+  spec.email         = ["adeel.rb@gmail.com"]
+
+  spec.summary       = %q{Ruby gem to interact with the Pinterest REST API}
+  spec.description   = %q{This gem makes it simple to interact with the official Pinterest REST API}
+  spec.homepage      = "http://github.com/realadeel"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "vcr", "~> 2.9"
+  spec.add_development_dependency "dotenv", "~> 2.0"
+
+  spec.add_dependency 'faraday', "~> 0.9"
+  spec.add_dependency 'faraday_middleware', "~> 0.10"
+  spec.add_dependency 'hashie', "~> 3.0"
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: pinterest-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adeel Ahmad
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem makes it simple to interact with the official Pinterest REST
+  API
+email:
+- adeel.rb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pinterest-api.rb
+- lib/pinterest/client.rb
+- lib/pinterest/client/board.rb
+- lib/pinterest/client/pin.rb
+- lib/pinterest/client/user.rb
+- lib/pinterest/version.rb
+- pinterest.gemspec
+homepage: http://github.com/realadeel
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby gem to interact with the Pinterest REST API
+test_files: []