instagram_public_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c551fc1531ad6bcda7005e5ba65df0092ac3b1ed
+  data.tar.gz: 7c2de66f3efbdc23b10d48a1cc836caf56b1e0bd
+SHA512:
+  metadata.gz: f4141716cdc95b4913556ca0e0b487b602a3d5acc029f78586054135defbf221709391a813152293aa353e36915e144195ec06e2185d7476643bc4450eabf7f9
+  data.tar.gz: 7349b071e43035433fc2d46365f52b98bd2322fdecae92ba8f45dace7b55cbb5629cca4dd0533563b0cf42d1a7e0b2e159b13cbf29236c47b09d1740b7c27116

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/README.md

@@ -0,0 +1,72 @@
+# Instagram Public API client
+
+A client/scraper/crawler for the public Instagram API. The client comes with handy methods such as passing a limit. The client will then proceed and crawl more data as required. Advanced configuration can be done using an http proxy.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'instagram_public_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install instagram_public_api
+
+## Usage
+
+**Get media for a location:**
+
+```
+InstagramPublicApi::Client.new.location_media("263928560", limit: 100, request_parameters: {})
+```
+
+**Get media for a hashtag:**
+
+```
+InstagramPublicApi::Client.new.hashtag_media("raccoon", limit: 100, request_parameters: {})
+```
+
+
+### Advanced configuration
+
+You can configure an HTTP Proxy in case you would like the requests to be done via an external service.
+
+
+```
+InstagramPublicApi.proxy_uri      = "http://foo"
+InstagramPublicApi.proxy_user     = "ubuntu"
+InstagramPublicApi.proxy_password = "mycrazypassword"
+
+```
+
+This proxy config will be used as the default proxy configuration for all following requests. When creating a client, you can pass an optional `http_service` with different proxy options as needed.
+
+``` 
+opts = {
+  uri: "http://customuri.com",
+  user: "customuser",
+  password: "custom-password",
+}
+service = InstagramPublicApi::HTTPService.new(proxy_config: opts)
+client  = InstagramPublicApi::Client.new(http_service: service)
+
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hendricius/instagram_public_api.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "instagram_public_api"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/instagram_public_api.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'instagram_public_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "instagram_public_api"
+  spec.version       = InstagramPublicApi::VERSION
+  spec.authors       = ["Hendrik Kleinwaechter"]
+  spec.email         = ["hendrik.kleinwaechter@gmail.com"]
+
+  spec.summary       = %q{Client for the public Instagram API}
+  spec.description   = %q{A client/scraper for the public Instagram API.}
+  spec.homepage      = "https://github.com/hendricius/instagram_public_api"
+
+  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.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
+
+  spec.add_runtime_dependency(%q<faraday>,       ["~> 0.8"])
+  spec.add_runtime_dependency "faraday_middleware"
+  spec.add_runtime_dependency "activesupport"
+  spec.add_runtime_dependency "virtus"
+end

data/lib/instagram_public_api.rb

@@ -0,0 +1,19 @@
+require 'json'
+require 'faraday'
+require 'faraday_middleware'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'pry'
+require 'pp'
+require 'virtus'
+
+require "instagram_public_api/version"
+require "instagram_public_api/http_service"
+require "instagram_public_api/client"
+require "instagram_public_api/entities/location"
+require "instagram_public_api/entities/medium_node"
+
+module InstagramPublicApi
+  class << self
+    attr_accessor :proxy_uri, :proxy_password, :proxy_user
+  end
+end

data/lib/instagram_public_api/client.rb

@@ -0,0 +1,96 @@
+module InstagramPublicApi
+  # client that holds the method for communicating with the Instagram API
+  class Client
+    attr_reader :http_service
+
+    def initialize(http_service: HTTPService.new, default_parameters: {})
+      @http_service       = http_service
+      @default_parameters = default_parameters.merge(build_default_parameters)
+    end
+
+    # returns a location with media attached for the given location id
+    #
+    # limit: the amount of media that should be fetched.
+    # request_parameters: optional parameters that will be passed to the request
+    def location_media(location_id, request_parameters: {limit: 1000}, limit: 10)
+      location = extract_location_media(location_id, request_parameters: request_parameters)
+      # check if we should get more data
+      paging_info = location.paging_info
+      # poll more data
+      while location.total_media_count < limit && paging_info[:has_next_page] do
+        request_opts = {}.merge(request_parameters)
+        if paging_info && paging_info[:end_cursor]
+          request_opts[:max_id] = paging_info[:end_cursor]
+        end
+        next_page_location = extract_location_media(location_id, request_parameters: request_opts)
+        location.add_media(next_page_location.media)
+        paging_info = next_page_location.paging_info
+        location
+      end
+      location
+    end
+
+    # returns a hashtag with media associated
+    #
+    # limit: the amount of media that should be fetched.
+    # request_parameters: optional parameters that will be passed to the request
+    def hashtag_media
+      raise ArgumentError, "not implemented yet"
+    end
+
+    private
+
+    # performs the actual request to the API.
+    #
+    # returns a Location object.
+    def extract_location_media(location_id, request_parameters: {})
+      uri   = "explore/locations/#{location_id}/"
+      data  = request(uri: uri, parameters: request_parameters)
+      body  = data.body[:location]
+      location = Entities::Location.new
+      attrs = %i[name lat lng id]
+      attrs.each do |attribute|
+        location.send("#{attribute}=", body[attribute])
+      end
+      media = {}
+      body[:media].fetch(:nodes, []).each do |medium|
+        media[medium[:id]] = Entities::MediumNode.new(medium)
+      end
+      location.media = media.values
+      location.top_posts = body[:top_posts].fetch(:nodes, []).map {|d| Entities::MediumNode.new(d)}
+      location.paging_info = body[:media].fetch(:page_info, {})
+      location
+    end
+
+    # perform the actual request. receives a URI as argument. Optional parameters
+    # and request parameter options can be passed.
+    #
+    # returns the raw http response
+    def request(uri:, request_options: {}, parameters: {})
+      opts = {
+        uri: uri,
+        request_options: request_options,
+        parameters: @default_parameters.merge(parameters)
+      }
+      parse_response(http_service.perform_request(opts))
+    end
+
+    # Common Parameters required for every call
+    def build_default_parameters
+      return {
+        __a: 1
+      }
+    end
+
+    # parses the raw response by the remote. returns an object with a raw_response
+    # as method and the parsed body associated.
+    def parse_response(response)
+      OpenStruct.new(
+        raw_response: response,
+        body: JSON.parse(response.body, symbolize_names: true)
+      )
+    end
+
+
+  end
+end

data/lib/instagram_public_api/entities.rb

@@ -0,0 +1,4 @@
+module InstagramPublicApi
+  module Entities
+  end
+end

data/lib/instagram_public_api/entities/location.rb

@@ -0,0 +1,30 @@
+module InstagramPublicApi
+  module Entities
+    class Location
+      include Virtus.model
+      attribute :name, String
+      attribute :lat, Float
+      attribute :lng, Float
+      attribute :id, String
+      attribute :top_posts, Array, default: []
+      attribute :media, Array, default: []
+      attribute :paging_info, Object, default: {}
+
+      # returns all media including top posts and media
+      def all_media
+        [top_posts, media].flatten.uniq{|m| m.id }.sort_by {|m| m.likes_count }.reverse
+      end
+
+      # adds an array of media to the location
+      def add_media(array)
+        array.each {|m| self.media << m }
+      end
+
+      # returns how much media has been added to this location.
+      def total_media_count
+        all_media.length
+      end
+
+    end
+  end
+end

data/lib/instagram_public_api/entities/medium_node.rb

@@ -0,0 +1,37 @@
+module InstagramPublicApi
+  module Entities
+    class MediumNode
+      include Virtus.model
+      attribute :code, String
+      attribute :dimensions, Hash, default: {}
+      attribute :comments, Hash, default: {}
+      attribute :owner, Hash, default: {}
+      attribute :likes, Hash, default: {}
+      attribute :date, Numeric
+      attribute :thumbnail_src, String
+      attribute :is_video, Boolean
+      attribute :id, String
+      attribute :display_src, String
+
+      # returns the likes count of the medium node
+      def likes_count
+        likes[:count] || 0
+      end
+
+      # returns true if the dimensions are a square
+      def is_square?
+        dimensions[:width] && dimensions[:height] && dimensions[:width] == dimensions[:height]
+      end
+
+      # returns true if the image is landscape mode
+      def is_landscape?
+        dimensions[:width] && dimensions[:height] && dimensions[:width] > dimensions[:height]
+      end
+
+      # returns true if the image is in portrait mode
+      def is_portrait?
+        dimensions[:width] && dimensions[:height] && dimensions[:height] > dimensions[:width]
+      end
+    end
+  end
+end

data/lib/instagram_public_api/http_service.rb

@@ -0,0 +1,51 @@
+module InstagramPublicApi
+  # http service that performs the requests to the instagram API
+  class HTTPService
+    API_SERVER = 'https://www.instagram.com/'
+
+    def initialize(proxy_config: nil)
+      if proxy_config
+        @proxy_config = proxy_config
+      elsif InstagramPublicApi.proxy_uri && InstagramPublicApi.proxy_user && InstagramPublicApi.proxy_password
+        @proxy_config = {
+          uri: InstagramPublicApi.proxy_uri,
+          user: InstagramPublicApi.proxy_user,
+          password: InstagramPublicApi.proxy_password,
+        }
+      end
+    end
+
+
+    # The address of the appropriate Expedia server.
+    #
+    # return a complete server address with protocol
+    def server_url
+      API_SERVER
+    end
+
+    # returns a hash with options for faraday
+    def faraday_options
+      options = {
+        url: server_url
+      }
+      if @proxy_config
+        options[:proxy] = @proxy_config
+      end
+      options
+    end
+
+    # performs the actual http request
+    def perform_request(request_options: {}, parameters: {}, uri:)
+      args = parameters
+      request_options = request_options.merge(faraday_options)
+      # figure out our options for this request
+      # set up our Faraday connection
+      connection = Faraday.new(faraday_options) do |faraday|
+        faraday.adapter  Faraday.default_adapter
+      end
+      connection.get(uri, args)
+    end
+
+
+  end
+end

data/lib/instagram_public_api/version.rb

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

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: instagram_public_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hendrik Kleinwaechter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A client/scraper for the public Instagram API.
+email:
+- hendrik.kleinwaechter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- instagram_public_api.gemspec
+- lib/instagram_public_api.rb
+- lib/instagram_public_api/client.rb
+- lib/instagram_public_api/entities.rb
+- lib/instagram_public_api/entities/location.rb
+- lib/instagram_public_api/entities/medium_node.rb
+- lib/instagram_public_api/http_service.rb
+- lib/instagram_public_api/version.rb
+homepage: https://github.com/hendricius/instagram_public_api
+licenses: []
+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
+signing_key: 
+specification_version: 4
+summary: Client for the public Instagram API
+test_files: []
+has_rdoc: