john_stamos 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c66ac4a130bded5d5012b17412f1a77cc975f7bb
+  data.tar.gz: 007cbf2771d8fb6ec1a96f78c47b863ddfd431ba
+SHA512:
+  metadata.gz: 60d24054779e9da576348520c20919f0f5f33c34574860615b71c82103781fce890ed059635f0e1b285f3584dc6a14d028a1cc5efc043ad9fc454f643f5e8395
+  data.tar.gz: ad0169ed7a5024733155002f2a6cec5b817c5f90aed770b0bd0ed77e959c734439bfeb6f060d71fcea4a6fb43b8b97b1a577c2133b56a5fd5f37435326a0b17f

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.DS_Store
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "2.0.0"
+script: bundle exec rspec

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 mariozig
+
+MIT License
+
+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,132 @@
+# JohnStamos 
+
+The greasiest Pinterest client. JohnStamos exposes an interface you can use to query Pinterest for data about individual Pins, Pinners and Pin searches.  Have mercy.
+
+[![Build Status](https://travis-ci.org/mariozig/john_stamos.png?branch=master)](https://travis-ci.org/mariozig/john_stamos)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'john_stamos'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install john_stamos
+
+Or finally, if none of that stuff applies to you, do what it takes to install the gem and add this to your script:
+
+    require 'john_stamos'
+
+## Usage
+
+### Searching for Pins
+
+Here's a typical use-case: You want to search Pinterest for some pins.  Once you have those pins, you want to access information about each individual pin as well as information about the person who pinned it.
+
+    client = JohnStamos::Client.new
+    
+    # Search for some sweet Pins of "pallet gardens"
+    pins = client.search_pins("pallet gardens", limit: 10)
+    # Returns an Array of Pin objects
+    
+    # The first Pin will be fun to investigate.
+    first_pallet_garden_pin = pallet_search.first
+    
+    # Print some info about the first Pin description
+    puts first_pallet_garden_pin.description
+    # => "A cool pallet garden"
+    
+    # the full sized image
+    puts first_pallet_garden_pin.image
+    # => "http://media-cache-ak0.pinimg.com/originals....whatever.jpg"
+    
+    # Pinterest's ID for this Pin
+    puts first_pallet_garden_pin.id
+    # => "123456789"
+    
+    # URL to the Pin
+    puts first_pallet_garden_pin.url
+    # => "http://pinterest.com/pin/123456789"
+    
+    # We can even get at the user who Pinned this Pin
+    first_pallet_garden_pin.pinner
+    
+    # Print the Pinner's full name
+    puts first_pallet_garden_pin.pinner.full_name
+    # => "Little Bobby Tables"
+
+### Using the Client
+
+The Client is the single entry point into all things JohnStamos. 
+
+    # Create a new Client
+    client = JohnStamos::Client.new
+    
+    # The Client also supports using a proxy
+    client_with_proxy = JohnStamos::Client.new(proxy: 'http://127.1.1.1:4747')
+    
+    # Note: If you're hosted on Heroku, you will want to use a proxy.
+
+
+### Accessing Individual Pin Data
+
+There are times you might want to access an individual Pin's information.  All you need is the ID assigned to the Pin by Pinterest to get going.
+
+    client = JohnStamos::Client.new
+    
+    # Get a magnificent Pin using it's ID
+    perfect_strangers_pin = client.pin(161848180328631541)
+    
+    puts perfect_strangers_pin.description
+    # => "Balki Bartokomous and Cousin Larry!!! PERFECT STRANGERS...loved that show!"
+    
+    puts perfect_strangers_pin.image
+    # => "http://media-cache-ec0.pinimg.com/originals/4b/10/d3/4b10d3bd1c172c52934eb2d79ff0031f.jpg"
+    
+    # If you didn't look at that image above, please do it before reading further
+    
+    puts perfect_strangers_pin.url
+    # => "http://pinterest.com/pin/161848180328631541/"
+    
+    puts perfect_strangers_pin.repin_count
+    # => 1
+
+### Accessing Pinner Data
+
+You can also query Pinterest for information about specific Pinners. Just pass in the Pinner's user name and you will be good to go.
+
+    client = JohnStamos::Client.new
+    
+    # Get Michelle Obama's account
+    michelle_obama = client.pinner("michelleobama")
+    
+    # Print some of the Pinner's information
+    puts michelle_obama.last_name
+    # => "Obama"
+    
+    puts michelle_obama.first_name
+    # => "Michelle"
+    
+    puts michelle_obama.pin_count
+    # => "81"
+    
+    puts michelle_obama.website_url
+    # => "http://www.barackobama.com"
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Notes
+
+- Currently tested against [Ruby 2.0 only](https://github.com/mariozig/john_stamos/blob/master/.travis.yml).
+- If you want to run tests locally I suggest you delete the [VCR cassettes](https://github.com/mariozig/john_stamos/tree/master/spec/support/vcr_cassettes) and start from scratch.  Pinterest changes OFTEN.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/john_stamos.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'john_stamos/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "john_stamos"
+  gem.version       = JohnStamos::VERSION
+  gem.authors       = ["mariozig"]
+  gem.email         = ["mariozig@gmail.com"]
+  gem.description   = %q{A Pinterest client}
+  gem.summary       = %q{An interface into Pinterest that exposes Pinners, Pins and searching. }
+  gem.homepage      = "http://github.com/mariozig/john_stamos/"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "bundler", "~> 1.3"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", "~> 2.6"
+  gem.add_development_dependency "webmock", "~> 1.8"
+  gem.add_development_dependency "vcr"
+  gem.add_development_dependency "guard-rspec"
+
+  gem.add_dependency "mechanize"
+  gem.add_dependency "rest-client"
+  gem.add_dependency "json"
+  gem.add_dependency "launchy"
+end

data/lib/john_stamos/client.rb

@@ -0,0 +1,57 @@
+class JohnStamos::Client
+  attr_accessor :proxy
+
+  def initialize(options={})
+    default_options = { proxy: nil }
+    options = default_options.merge(options)
+    @proxy = options[:proxy]
+  end
+
+  def search_pins(search_text, options={})
+    search_scraper = JohnStamos::PinSearch.new(self, search_text, options)
+    search_scraper.execute!
+
+    search_scraper.pins
+  end
+
+  def pin(pinterest_pin_id)
+    JohnStamos::Pin.new(self, pinterest_pin_id)
+  end
+
+  def pinner(username)
+    JohnStamos::Pinner.new(self, username)
+  end
+
+  def page_content(url)
+    begin
+      page = mechanize_agent.get(url)
+    rescue Mechanize::ResponseReadError => e
+      $stderr.puts "#{e.class}: #{e.message}"
+      $stderr.puts "An error occured; attempting to force_parse"
+      page = e.force_parse
+    end
+
+    page
+  end
+
+  def json_content(url, params)
+    RestClient.proxy = @proxy
+    response = RestClient.get(url, params: params, accept: :json, "X-Requested-With" => "XMLHttpRequest")
+
+    JSON.parse(response)
+  end
+
+  private
+    def mechanize_agent
+      agent = Mechanize.new
+      agent.user_agent_alias = 'Mac Safari'
+
+      if @proxy
+        proxy_uri = URI.parse(@proxy)
+        agent.set_proxy(proxy_uri.hostname, proxy_uri.port)
+      end
+
+      agent
+    end
+
+end

data/lib/john_stamos/pin.rb

@@ -0,0 +1,78 @@
+class JohnStamos::Pin
+  attr_reader :id
+
+  def initialize(client, pinterest_pin_id)
+    @id = pinterest_pin_id
+    @client = client
+  end
+
+  def image
+    embedded_pin_data["images"]["orig"]["url"]
+  end
+
+  def video?
+    embedded_pin_data("is_video")
+  end
+
+  def description
+    embedded_pin_data("description")
+  end
+
+  # TODO: Make this a Board object... not just a url
+  def board
+    embedded_pin_data["board"]["url"]
+  end
+
+  def like_count
+    embedded_pin_data("like_count")
+  end
+
+  def repin_count
+    embedded_pin_data("repin_count")
+  end
+
+  def source_url
+    embedded_pin_data("link")
+  end
+
+  def pinner
+    JohnStamos::Pinner.new(@client, embedded_pin_data["pinner"]["username"])
+  end
+
+  def url
+    "http://pinterest.com/pin/#{@id}/"
+  end
+
+
+
+  private
+    def page
+      @page ||= @client.page_content(url)
+    end
+
+    def embedded_pin_json
+      embedded_script = page.search('script').select do |script|
+        script['src'].nil? && script.content.include?('Pc.startArgs')
+      end
+
+      embedded_script_content = embedded_script.first.content
+      # This regex used in the range snatches the parameter Pinterest uses to
+      # start their app... This parameter happens to be a JSON representation of
+      # the page.
+      raw_json = embedded_script_content[/Pc.startArgs = (.*);/, 1]
+      embedded_script_json = JSON.parse(raw_json)
+
+      embedded_script_json
+    end
+
+    def embedded_pin_data(attribute=nil)
+      value = embedded_pin_json["tree"]["options"]["module"]["data"]
+
+      if !attribute.nil?
+        value = value[attribute]
+      end
+
+      value
+    end
+
+end

data/lib/john_stamos/pin_search.rb

@@ -0,0 +1,150 @@
+class JohnStamos::PinSearch
+  attr_accessor :next_bookmark, :search_text, :pin_ids, :limit
+
+  def initialize(client, search_text=nil, options={})
+    default_options = { limit: 50 }
+    options = default_options.merge(options)
+    @limit = options.fetch(:limit)
+
+    @client = client
+    @search_text = search_text
+
+    @pins, @pin_ids = [], []
+    @next_bookmark = nil
+  end
+
+  def execute!
+    raise JohnStamos::MissingSearchText if @search_text.nil?
+
+    first_retrieval!
+
+    until limit_reached? do
+      subsequent_retrieval!
+    end
+  end
+
+  def first_retrieval_url
+    raise JohnStamos::MissingSearchText if @search_text.nil?
+    "http://pinterest.com/search/pins/?q=#{URI::encode(@search_text)}"
+  end
+
+  def subsequent_retrieval_url
+    'http://pinterest.com/resource/SearchResource/get/'
+  end
+
+  def first_retrieval!
+    page = @client.page_content(first_retrieval_url)
+
+    embedded_script = page.search('script').select do |script|
+      script['src'].nil? && script.content.include?('Pc.startArgs')
+    end
+
+    embedded_script_content = embedded_script.first.content
+    # This regex used in the range snatches the parameter Pinterest uses to
+    # start their app... This parameter happens to be a JSON representation of
+    # the page.
+    raw_json = embedded_script_content[/Pc.startArgs = (.*);/, 1]
+    embedded_script_json = JSON.parse(raw_json)
+
+    pin_ids_from_embedded_script_json = pin_ids_from_first_retrieval(embedded_script_json)
+
+    pin_ids_up_to_limit(pin_ids_from_embedded_script_json)
+    @next_bookmark = next_bookmark_from_first_retrieval(embedded_script_json)
+  end
+
+  def subsequent_retrieval!
+    raise JohnStamos::MissingNextBookmark if @next_bookmark.nil?
+    raise JohnStamos::MissingSearchText if @search_text.nil?
+
+    pins_json = @client.json_content(subsequent_retrieval_url, build_url_params)
+    pin_ids_from_json = pin_ids_from_subsequent_retrieval(pins_json)
+    pin_ids_up_to_limit(pin_ids_from_json)
+
+    @next_bookmark = next_bookmark_from_subsequent_retrieval(pins_json)
+  end
+
+  def more_results?
+    raise JohnStamos::MissingNextBookmark if @next_bookmark.nil?
+    @next_bookmark != "-end-"
+  end
+
+  def limit_reached?
+    @pin_ids.length == @limit.to_i
+  end
+
+  def pins
+    @pin_ids.map do |pinterest_pin_id|
+      JohnStamos::Pin.new(@client, pinterest_pin_id)
+    end
+  end
+
+  private
+    def pin_ids_from_first_retrieval(json)
+      json["tree"]["options"]["module"]["data"]["results"].map{ |pin| pin["id"] }
+    end
+
+    def pin_ids_from_subsequent_retrieval(json)
+      json["module"]["tree"]["children"].map{ |pin| pin["resource"]["options"]["id"] }
+    end
+
+    def next_bookmark_from_first_retrieval(json)
+      base_search_child = json["tree"]["children"].select do |child|
+        next if child["resource"].nil? || child["resource"]["name"].nil?
+        child["resource"]["name"] == "BaseSearchResource"
+      end
+      next_bookmark = base_search_child.first["resource"]["options"]["bookmarks"].first
+
+      next_bookmark
+    end
+
+    def next_bookmark_from_subsequent_retrieval(json)
+      json["module"]["tree"]["resource"]["options"]["bookmarks"].first
+    end
+
+    def build_url_params
+      data_json = {
+                    options: {
+                      query: search_text,
+                      bookmarks: [@next_bookmark],
+                      show_scope_selector: true,
+                      scope: "pins"
+                    },
+                    context: {
+                      app_version: "e26ef9c"
+                    },
+                    "module" => {
+                      name: "GridItems",
+                      options: {
+                        scrollable: true,
+                        show_grid_footer: true,
+                        centered: true,
+                        reflow_all: true,
+                        virtualize: true,
+                        item_options: {
+                          show_pinner: true,
+                          show_pinned_from: false,
+                          show_board: true
+                        },
+                        layout: "variable_height"
+                      },
+                      append: true,
+                      error_strategy: 1
+                    }
+                  }
+
+      url_params = {
+                    source_url: "/search/pins/?q=#{URI::encode(search_text)}",
+                    "_" => 1375127302668,
+                    data: data_json.to_json
+                   }
+      url_params
+    end
+
+    def pin_ids_up_to_limit(ids)
+      ids.each do |id|
+        break if limit_reached?
+        @pin_ids << id
+      end
+    end
+
+end

data/lib/john_stamos/pinner.rb

@@ -0,0 +1,81 @@
+require 'json'
+
+class JohnStamos::Pinner
+  attr_reader :username
+
+  def initialize(client, username)
+    @client = client
+    @username = username
+  end
+
+  def url
+    "http://pinterest.com/#{@username}/"
+  end
+
+  def pin_count
+    embedded_pinner_data("pin_count")
+  end
+
+  def about
+    embedded_pinner_data("about")
+  end
+
+  def follower_count
+    embedded_pinner_data("follower_count")
+  end
+
+  def board_count
+    embedded_pinner_data("board_count")
+  end
+
+  def avatar
+    embedded_pinner_data("image_large_url")
+  end
+
+  def first_name
+    embedded_pinner_data("first_name")
+  end
+
+  def last_name
+    embedded_pinner_data("last_name")
+  end
+
+  def full_name
+    embedded_pinner_data("full_name")
+  end
+
+  def website_url
+    embedded_pinner_data("website_url")
+  end
+
+  def location
+    embedded_pinner_data("location")
+  end
+
+  private
+    def page
+      @page ||= @client.page_content(url)
+    end
+
+    def embedded_pinner_json
+      embedded_script = page.search('script').select do |script|
+        script['src'].nil? && script.content.include?('Pc.startArgs')
+      end
+
+      embedded_script_content = embedded_script.first.content
+      # This regex used in the range snatches the parameter Pinterest uses to
+      # start their app... This parameter happens to be a JSON representation of
+      # the page.
+      raw_json = embedded_script_content[/Pc.startArgs = (.*);/, 1]
+      embedded_script_json = JSON.parse(raw_json)
+
+      embedded_script_json
+    end
+
+    def embedded_pinner_data(attribute)
+      value = embedded_pinner_json["tree"]["options"]["module"]["data"][attribute]
+      value = "" if value.nil?
+
+      value
+    end
+end

data/lib/john_stamos/version.rb

@@ -0,0 +1,3 @@
+module JohnStamos
+  VERSION = "0.0.1"
+end

data/lib/john_stamos.rb

@@ -0,0 +1,20 @@
+require 'mechanize'
+require 'json'
+require 'rest_client'
+require 'launchy'
+
+require 'john_stamos/version'
+require 'john_stamos/client'
+require 'john_stamos/pin_search'
+require 'john_stamos/pin'
+require 'john_stamos/pinner'
+
+module JohnStamos
+  class MissingSearchText < Exception; end
+  class MissingNextBookmark < Exception; end
+
+  private
+    def self.uncle_jesse
+      Launchy.open('http://www.youtube.com/watch?v=bLqAqIj8Rdc')
+    end
+end