instagram_api_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 64ea4b37b0138bbd3d2c8da8f47db69ae42a94b9
+  data.tar.gz: ee8af806017b7327754a832edf711ca4117cb004
+SHA512:
+  metadata.gz: 5fcb4202fd585628871edf2fa4637029c7767d57e9a7d646f0b8cb0758147f8a1235cc1ba0f557778d536c0571dcd40cda1f1be42802b9f0ce7dd82d5cf1f22e
+  data.tar.gz: 7829f62adf748a4ec94b914f57cdd740803d70d94c69bfccc81e0a9a0a62871b3c2b26bedf31a0802fe4717ad587ff7919ab549e37cff6d500a91b8a6696b444

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.idea
+instagram_api-*.gem

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sergey.mell@agilie.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016-2017 Agilie Team info@agilie.com
+
+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,56 @@
+[![License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/agilie/GoButton)
+
+# InstagramApi
+
+A Ruby wrapper for the Instagram API. 
+You can see the api endpoints here https://www.instagram.com/developer/endpoints/
+
+## Installation
+
+```ruby
+gem install instagram_api
+```
+
+## Usage
+
+Before you start making the requests to instagram API provide the `access_token` using the configuration
+wrapping.
+
+```ruby
+InstagramAPI.config do |config|
+  config.access_token = 'put_your_token_here'
+end
+```
+
+As for now Instagram access token doesn't change or expire, so you can use this simple-to-use service
+to generate it http://services.chrisriversdesign.com/instagram-token/
+I the nearest future the OAuth authorization for access token fetching will be implemented.
+
+## TODOS
+
+1. OAuth authorization for access token fetching
+2. Incode Documentation
+3. Cover functionality with tests
+
+## Troubleshooting
+
+Problems? Check the [Issues](https://github.com/agilie/instagram_api_gem/issues) block to find 
+the solution or create an new issue that we will fix asap. Feel free to contribute.
+This project is intended to be a safe, welcoming space for collaboration.
+
+## Author
+This gem is open-sourced by [Agilie Team](https://www.agilie.com) ([info@agilie.com](mailto:info@agilie.com))
+
+## Contributor
+[Sergey Mell](https://github.com/SergeyMell)
+
+## Contact us
+If you have any questions, suggestions or just need a help with web or mobile development, 
+please email us at <web@agilie.com>. You can ask us anything from basic to complex questions.
+
+We will continue publishing new open-source projects. Stay with us, more updates will follow!
+
+## License
+
+The gem is available as open source under the [MIT](LICENSE.md) License (MIT) Copyright © 2017 [Agilie Team](https://www.agilie.com)
+

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_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(__FILE__)

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_api.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'instagram_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'instagram_api_client'
+  spec.version       = InstagramApi::VERSION
+  spec.authors       = ['SergeyMell']
+  spec.email         = ['sergey.mell@agilie.com']
+
+  spec.summary       = 'A Ruby wrapper for the Instagram API'
+  spec.description   = 'A Ruby wrapper for the Instagram API'
+
+  spec.homepage      = 'https://github.com/agilie/instagram_api_gem'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'plural'
+  spec.add_dependency 'hashie'
+end

data/lib/instagram_api.rb

@@ -0,0 +1,31 @@
+require 'instagram_api/version'
+
+require 'instagram_api/client'
+require 'instagram_api/common'
+
+require 'instagram_api/user'
+require 'instagram_api/tag'
+require 'instagram_api/location'
+require 'instagram_api/media'
+require 'instagram_api/configuration'
+
+module InstagramApi
+  extend Configuration
+
+  RESOURCES = %w(user location tag media).freeze
+
+  class << self
+    RESOURCES.each do |resource|
+      define_method resource do |resource_id = nil|
+        klass_name(resource).new(resource_id)
+      end
+    end
+
+    private
+
+    def klass_name(resource)
+      "InstagramApi::#{resource.capitalize}".split('::').inject(Object) {|o, c| o.const_get c}
+    end
+  end
+
+end

data/lib/instagram_api/client.rb

@@ -0,0 +1,59 @@
+require 'httparty'
+require 'plural'
+require 'hashie'
+require 'instagram_api/exceptions'
+
+module InstagramApi
+
+  module Client
+
+    include HTTParty
+
+    BASE_API_URI = 'https://api.instagram.com/v1'.freeze
+
+    ERROR_CODES = {
+      400 => BadRequest,
+      404 => NotFound,
+      429 => TooManyRequests,
+      500 => InternalServerError,
+      502 => BadGateway,
+      503 => ServiceUnavailable,
+      504 => GatewayTimeout
+    }.freeze
+
+    protected
+
+    def resource_path(id = nil)
+      resource = self.class.name.split('::').last.downcase.plural
+      suffix = id ? "/#{id}" : ''
+      "#{BASE_API_URI}/#{resource}#{suffix}?access_token=#{InstagramApi.access_token}"
+    end
+
+    def make_request(url, options, method = :get)
+      response = HTTParty.send(method, url, options)
+      if response.success?
+        parse_success response
+      else
+        parse_failed response
+      end
+    end
+
+    private
+
+    def parse_success(response)
+      response_hash = JSON.parse(response.body).merge(
+        limit: response.headers['x-ratelimit-limit'],
+        remaining: response.headers['x-ratelimit-remaining']
+      )
+      ::Hashie::Mash.new(response_hash)
+    end
+
+    def parse_failed(response)
+      error = ERROR_CODES[response.code].new(response)
+      raise error, error.message
+    end
+
+  end
+
+end
+

data/lib/instagram_api/common.rb

@@ -0,0 +1,42 @@
+require 'instagram_api/client'
+
+module InstagramApi
+
+  module Search
+    include Client
+
+    def search(query, options = {})
+      make_request resource_path('search'), query: options.merge(q: query)
+    end
+  end
+
+  module Resource
+    include Client
+
+    private
+
+    def show(id, options = {})
+      raise 'Resource ID is required' unless id
+      make_request resource_path(id), query: options
+    end
+
+    def index(id, resource_name, options = {})
+      raise 'Resource ID is required' unless id
+      make_request resource_path("#{id}/#{resource_name}"), query: options
+    end
+
+    def create(id, resource_name, options = {})
+      raise 'Resource ID is required' unless id
+      make_request(resource_path("#{id}/#{resource_name}"), { body: options }, :post)
+    end
+
+    def destroy(id, resource_name, resource_id = nil, options = {})
+      raise 'Resource ID is required' unless id
+      path = "#{id}/#{resource_name}"
+      path = "#{path}/#{resource_id}" if resource_id
+      make_request(resource_path(path), { query: options }, :delete)
+    end
+  end
+
+end
+

data/lib/instagram_api/configuration.rb

@@ -0,0 +1,15 @@
+module InstagramApi
+  module Configuration
+
+    OPTIONS = [
+      :access_token
+    ].freeze
+
+    attr_accessor *OPTIONS
+
+    def config
+      yield self
+    end
+
+  end
+end

data/lib/instagram_api/exceptions.rb

@@ -0,0 +1,51 @@
+module InstagramApi
+
+  class Error < StandardError
+    attr_reader :message, :type, :code
+
+    def initialize(response)
+      body = JSON.parse(response.body)
+
+      @code = "#{response[:status]}"
+      @type = body['meta']['error_type']
+      @message = body['meta']['error_message']
+    end
+  end
+
+  # Raised when Instagram returns the HTTP status code 400
+  class BadRequest < Error
+  end
+
+  # Raised when Instagram returns the HTTP status code 404
+  class NotFound < Error
+  end
+
+  # Raised when Instagram returns the HTTP status code 429
+  class TooManyRequests < Error
+  end
+
+  # Raised when Instagram returns the HTTP status code 500
+  class InternalServerError < Error
+  end
+
+  # Raised when Instagram returns the HTTP status code 502
+  class BadGateway < Error
+  end
+
+  # Raised when Instagram returns the HTTP status code 503
+  class ServiceUnavailable < Error
+  end
+
+  # Raised when Instagram returns the HTTP status code 504
+  class GatewayTimeout < Error
+  end
+
+  # Raised when a subscription payload hash is invalid
+  class InvalidSignature < Error
+  end
+
+  # Raised when Instagram returns the HTTP status code 429
+  class RateLimitExceeded < Error
+  end
+
+end

data/lib/instagram_api/location.rb

@@ -0,0 +1,18 @@
+require 'instagram_api/common'
+
+module InstagramApi
+
+  class Location
+    include Search
+
+    def initialize(location_id = nil)
+      @location_id = location_id
+    end
+
+    def recent_media(options = {})
+      index @location_id, 'media/recent', options
+    end
+  end
+
+end
+

data/lib/instagram_api/media.rb

@@ -0,0 +1,47 @@
+require 'instagram_api/common'
+
+module InstagramApi
+
+  class Media
+    include Search
+    include Resource
+
+    def initialize(media_id = nil)
+      @media_id = media_id
+    end
+
+    def show(options = {})
+      super @media_id, options
+    end
+
+    def short_code(short_code, options = {})
+      make_request resource_path("shortcode/#{short_code}"), query: options
+    end
+
+    def likes(options = {})
+      index(@media_id, 'likes', options)
+    end
+
+    def add_like(options = {})
+      create(@media_id, 'likes', options)
+    end
+
+    def delete_like(options = {})
+      destroy(@media_id, 'likes', nil, options)
+    end
+
+    def comments(options = {})
+      index(@media_id, 'comments', options)
+    end
+
+    def add_comment(options = {})
+      create(@media_id, 'comments', options)
+    end
+
+    def delete_comment(comment_id, options = {})
+      destroy(@media_id, 'comments', comment_id, options)
+    end
+  end
+
+end
+

data/lib/instagram_api/tag.rb

@@ -0,0 +1,19 @@
+require 'instagram_api/common'
+
+module InstagramApi
+
+  class Tag
+    include Search
+    include Resource
+
+    def initialize(tag_id = nil)
+      @tag_id = tag_id
+    end
+
+    def recent_media(options = {})
+      index @tag_id, 'media/recent', options
+    end
+  end
+
+end
+

data/lib/instagram_api/user.rb

@@ -0,0 +1,42 @@
+require 'instagram_api/common'
+
+module InstagramApi
+
+  class User
+    include Search
+    include Resource
+
+    def initialize(user_id)
+      @user_id = user_id || 'self'
+    end
+
+    def show(options = {})
+      super @user_id, options
+    end
+
+    def recent_media(options = {})
+      index @user_id, 'media/recent', options
+    end
+
+    def liked_media(options = {})
+      index @user_id, 'media/liked', options
+    end
+
+    def follows(options = {})
+      make_request resource_path('self/follows'), query: options
+    end
+
+    def followed_by(options = {})
+      make_request resource_path('self/followed-by'), query: options
+    end
+
+    def check_relationship(user_id, options = {})
+      make_request resource_path("#{user_id}/relationship"), query: options
+    end
+
+    def change_relationship(user_id, options = {})
+      make_request resource_path("#{user_id}/relationship"), {body: options}, :post
+    end
+  end
+
+end

data/lib/instagram_api/version.rb

@@ -0,0 +1,3 @@
+module InstagramApi
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: instagram_api_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- SergeyMell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: httparty
+  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: plural
+  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: hashie
+  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 Ruby wrapper for the Instagram API
+email:
+- sergey.mell@agilie.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- instagram_api.gemspec
+- lib/instagram_api.rb
+- lib/instagram_api/client.rb
+- lib/instagram_api/common.rb
+- lib/instagram_api/configuration.rb
+- lib/instagram_api/exceptions.rb
+- lib/instagram_api/location.rb
+- lib/instagram_api/media.rb
+- lib/instagram_api/tag.rb
+- lib/instagram_api/user.rb
+- lib/instagram_api/version.rb
+homepage: https://github.com/agilie/instagram_api_gem
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.3
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the Instagram API
+test_files: []