bundl_instagram_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a3f23a75d61a18e52ea5a321dcfa0be0b3fe49d57703fa74f8add56bc3d2e0d3
+  data.tar.gz: 504f3f7d0957352958aa4da4d31908797f516de3eee4a4fbe3e6115863439f37
+SHA512:
+  metadata.gz: e292358f69e7c4106d874c03834a85035816927a09a8699e451005ee5b2fecbd0dcc4319789c7c0e0442fb13aedaf719bb02a51bd5dfbc468dc581979afb72f2
+  data.tar.gz: f6f1f738194e9e949b1d9c11a76b18fff445f9a77a879fc59c96b0aae6e9a5dfb9687abb92200b6fb545cb27070c7417887cfa60f12036658fcf875bb6185502

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

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 rakesh.patra@mindfiresolutions.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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in instagram_graph_api.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Rakesh kumar Patra
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 TODO: Write your name
+
+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,86 @@
+# InstagramGraphApi
+
+A gem for Instagram Graph API using [koala](https://github.com/arsduo/koala).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'instagram_graph_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install instagram_graph_api
+
+## Usage
+
+```ruby
+client = InstagramGraphApi.client(ACCESS_TOKEN)
+
+#get an arraay of business accounts linked to the access_token
+client.ig_business_accounts
+#get an array of connected IG accounts linked to the access_token
+client.connected_ig_accounts
+
+#to get specific fields from "id,name,biography,ig_id,followers_count,profile_picture_url,username"
+client.ig_business_accounts("name,followers_count")
+client.connected_ig_accounts("name,followers_count")
+
+#get IG business account/ Connected IG account info
+client.get_account_info(IG_BUSINESS_ID)
+#to get specific fields
+fields = "name, biography"
+client.get_account_info(IG_BUSINESS_ID, fields)
+
+#get media list
+client.get_user_recent_media(IG_BUSINESS_ID)
+
+#get media details
+client.get_media_details(MEDIA_ID)
+#to get specific fields
+fields  = "media_url, permalink"
+client.get_media_details(MEDIA_ID, fields)
+
+#Discover business user
+client.discover_user(USERNAME)
+# fields can be from "id,followers_count,media_count,ig_id"
+fields = "followers_count,media_count,ig_id"
+client.discover_user(USERNAME, fields)
+
+#discover user media, fields can be "caption,media_url,media_type,like_count,comments_count,id"
+client.discover_user_media(USERNAME, fields)
+
+#Search for a tag, 
+client.tag_media(page_token, tag_name)
+#fields can be "media_type,comments_count,like_count,media_url,permalink"
+fields="media_url,permalink"
+client.tag_media(page_token, tag_name, fields)
+#custom edge can be provided, default is 'top_media'
+tag_media = client.tag_media(page_token, tag_name, edge: "recent_media")
+# Note: We can run `tag_media.next_page` to fetch next set of results
+# additional arguent options can also be passed for page params i.e before/after/limit etc
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/rakeshpatra/instagram_graph_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the InstagramGraphApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rakeshpatra/instagram_graph_api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bundl_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

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/bundl_instagram_api.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bundl_instagram_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bundl_instagram_api"
+  spec.version       = BundlInstagramApi::VERSION
+  spec.authors       = ["Tyler"]
+  spec.email         = ["tyler@trybundl.com"]
+
+  spec.summary       = %q{Bundl's Instagram Graph API}
+  spec.description   = %q{New Instagram Graph API}
+  spec.homepage      = "https://github.com/tameyer41/bundl_instagram-api"
+  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"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.16"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "pry"
+  spec.add_dependency "koala"
+end

data/lib/bundl_instagram_api/client/discovery.rb

@@ -0,0 +1,22 @@
+module BundlInstagramApi
+  class Client
+    module Discovery
+      def discover_user(username, fields = nil)
+        fields ||= "id,followers_count,media_count,ig_id"
+        bg_id = get_business_account_id
+        raise "No business-account found, you need to have atleast one IG business-account" unless bg_id
+        query = "?fields=business_discovery.username(#{username}){#{fields}}"
+        get_connections(bg_id, query)
+      rescue Exception => e
+        puts e.message
+      end
+
+      def discover_user_media(username, fields = nil, options={})
+        fields ||= "caption,media_url,media_type,like_count,comments_count,id"
+        page_options = ".after(#{options['after']})" if options["after"]
+        page_options = ".after(#{options['before']})" if options["before"]
+        discover_user(username, "media#{page_options}{#{fields}}")
+      end
+    end
+  end
+end

data/lib/bundl_instagram_api/client/insights.rb

@@ -0,0 +1,30 @@
+module BundlInstagramApi
+  class Client
+    module Insights
+
+      METRIC_HASH = {
+        image: 'impressions,reach',
+        video: 'impressions,reach,video_views',
+        story: 'impressions,replies,reach,taps_forward,taps_back,exits'
+      }
+
+      def insights(object_id, type: "image", metrics: nil)
+        metrics ||= METRIC_HASH[type.to_sym]
+        @raw_insights = get_connections(object_id, "insights?metric=#{metrics}")
+        @raw_insights.reduce({}) do |result, insight_data|
+          result[insight_data["name"]] = insight_data["values"].first["value"]
+          result
+        end
+      end
+
+      def user_insights(object_id, metrics: nil, period:nil)
+        @raw_insights = get_connections(object_id, "insights?metric=#{metrics}&period=#{period}")
+        @raw_insights.reduce({}) do |result, insight_data|
+          result[insight_data["name"]] = insight_data["values"].first["value"]
+          result
+        end
+      end
+
+    end
+  end
+end

data/lib/bundl_instagram_api/client/media.rb

@@ -0,0 +1,31 @@
+module BundlInstagramApi
+  class Client
+    module Media
+      attr_accessor :media_info, :raw_insights
+
+      MEDIA_INFO_HASH = {
+        image: "comments_count,like_count,media_type,"\
+                    "media_url,permalink,timestamp,thumbnail_url",
+        video: "comments_count,like_count,media_type,"\
+                    "media_url,permalink,timestamp,thumbnail_url",
+        story: "media_type,media_url,permalink,"\
+                      "timestamp,thumbnail_url"
+      }
+
+      def get_user_recent_media(id, fields = nil, type: "image", options: {})
+        entity = type.eql?("story") ? "stories" : "media"
+        fields ||= MEDIA_INFO_HASH[type.to_sym]
+        query = "#{entity}?fields=#{fields}"
+        query += "&after=#{options[:after]}" if options[:after]
+        query += "&before=#{options[:before]}" if options[:before]
+        get_connections(id, query)
+      end
+
+      def get_media_details(media_id, fields = nil, type: "image")
+        fields ||= MEDIA_INFO_HASH[type.to_sym]
+        get_connections(media_id , "?fields=#{fields}")
+      end
+
+    end
+  end
+end

data/lib/bundl_instagram_api/client/tag.rb

@@ -0,0 +1,21 @@
+module BundlInstagramApi
+  class Client
+    module Tag
+      def tag_media(page_token, tag_name, fields = nil, edge: "top_media", options: {})
+        user_id = get_ig_id_from_token(page_token)
+        tag_info = graph_call("ig_hashtag_search?user_id=#{user_id}&q=#{tag_name}")[0]
+        fields ||= "id,media_type,comments_count,like_count,media_url,permalink"
+        query = "#{edge}?user_id=#{user_id}&fields=#{fields}"
+        query += options.reduce(""){|s, (k, v)| s+= "&#{k}=#{v}" }
+        get_connections(tag_info["id"], query)
+      end
+
+      private
+
+      def get_ig_id_from_token(token)
+        account_info = get_connections('me', "?fields=connected_instagram_account")
+        account_info.dig("connected_instagram_account", "id")
+      end
+    end
+  end
+end

data/lib/bundl_instagram_api/client/users.rb

@@ -0,0 +1,41 @@
+module BundlInstagramApi
+  class Client
+    module Users
+      def ig_business_accounts(fields = nil)
+        fields ||= 'id,name,biography,ig_id,followers_count,profile_picture_url,username'
+        accounts = get_pages("?fields=instagram_business_account{#{fields}}")
+        accounts.map do |a|
+          a["instagram_business_account"].merge(page_id: a["id"]) if a["instagram_business_account"]
+        end.compact
+      end
+
+      def connected_ig_accounts(fields = nil)
+        fields ||= 'id,name,biography,ig_id,followers_count,profile_picture_url,username'
+        accounts = get_pages("?fields=connected_instagram_account{#{fields}}")
+        accounts.map do |a|
+          a["connected_instagram_account"].merge(page_id: a["id"]) if a["connected_instagram_account"]
+        end.compact
+      end
+
+      def get_account_info(ig_account_id, fields = nil)
+        fields ||= "biography,followers_count,ig_id,name,profile_picture_url,username,id"
+        get_connections(ig_account_id , "?fields=#{fields}")
+      end
+
+      private
+
+      def get_pages(params="")
+        begin
+          get_connections('me', "accounts#{params}")
+        rescue Exception => e
+          puts e.message
+          []
+        end
+      end
+
+      def get_business_account_id
+        ig_business_accounts.first.dig('id')
+      end
+    end
+  end
+end

data/lib/bundl_instagram_api/client.rb

@@ -0,0 +1,13 @@
+require 'koala'
+
+module BundlInstagramApi
+  class Client < Koala::Facebook::API
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
+
+    include BundlInstagramApi::Client::Insights
+    include BundlInstagramApi::Client::Users
+    include BundlInstagramApi::Client::Media
+    include BundlInstagramApi::Client::Discovery
+    include BundlInstagramApi::Client::Tag
+  end
+end

data/lib/bundl_instagram_api/version.rb

@@ -0,0 +1,3 @@
+module BundlInstagramApi
+  VERSION = "1.0.0"
+end

data/lib/bundl_instagram_api.rb

@@ -0,0 +1,9 @@
+require "bundl_instagram_api/version"
+require "bundl_instagram_api/client"
+
+module BundlInstagramApi
+  # Your code goes here...
+  def self.client(token)
+    BundlInstagramApi::Client.new(token)
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: bundl_instagram_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tyler
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !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: koala
+  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: New Instagram Graph API
+email:
+- tyler@trybundl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bundl_instagram_api.gemspec
+- lib/bundl_instagram_api.rb
+- lib/bundl_instagram_api/client.rb
+- lib/bundl_instagram_api/client/discovery.rb
+- lib/bundl_instagram_api/client/insights.rb
+- lib/bundl_instagram_api/client/media.rb
+- lib/bundl_instagram_api/client/tag.rb
+- lib/bundl_instagram_api/client/users.rb
+- lib/bundl_instagram_api/version.rb
+homepage: https://github.com/tameyer41/bundl_instagram-api
+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: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Bundl's Instagram Graph API
+test_files: []