insta-api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eca997b85232a9f662773edbd8fc208e7bb69e3fd23ceb8d1ac011168cb649f0
-  data.tar.gz: 792f390da28c8e0cf3d2b796924fccb9f59db0c82a5a158ea3d0b31645173ff1
+  metadata.gz: 398a2364b881d3a920967054ba95ea4b6e04a914515697aaad512fae17f7821b
+  data.tar.gz: 558514d258235e96a01abf3b759b5622c93b9712f6c2cf68a83353208d54d559
 SHA512:
-  metadata.gz: a416b49a690f651a965b4193476bf838ab540695453ecb7336466cad4c207e10b347c982060da01e84e443f737492a895a12aa1bcc3548b324a8312fba0eb952
-  data.tar.gz: c582e7dabb2339157aab850e3795c1ff4937c03de4a81bd3d6e99383dd8fb30ff30d0ac0d4dce785544121cf0e049dfb8aaad847002568276ce3bb7095c9a983
+  metadata.gz: 0a55759f7629926bd2e69884c5776f40b232f0644b1ba024979bbabfe44e53617ce565861b2f58ac17e9d5e3f5cfb32dda5dd24332e109212e8a60bd2ef00201
+  data.tar.gz: 9ce5c91b08bfb9e1c8a2794d5028daaa35d0537aaa6ec94e1f7bdfab1738b1821891a1684d2f4031bf1df080074c50ac73f935d08f8244befe734e067478b235

data/README.md

@@ -1,15 +1,15 @@
-# Insta
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/insta`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+# Instagram
+The [Instagram Basic Display API](https://developers.facebook.com/docs/instagram-basic-display-api) allows users of your app to get basic profile information, photos, and videos in their Instagram accounts.
+The API can be used to access any type of Instagram account but only provides read-access to basic data.
 
+## Source
+- [Facebook developers docs](https://developers.facebook.com/docs/instagram-basic-display-api)
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'insta'
+gem 'insta-api'
 ```
 
 And then execute:
@@ -18,27 +18,71 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install insta
+    $ gem install insta-api
 
-## Usage
 
-TODO: Write usage instructions here
+## Usage
+##### Step 1: Authorization Window URL
+Construct the Authorization Window URL below, replacing {app-id} with your Instagram app’s ID (from the App `Dashboard > Products > Instagram > Basic Display > Instagram App ID field`), replacing {app-secret} with your Instagram app’s ID (from the App `Dashboard > Products > Instagram > Basic Display > Instagram App Secret`) and {redirect-uri} with your website URL that you provided in Step 2 (`Valid OAuth Redirect URIs`). The URL must be exactly the same.
+```sh
+> require 'insta'
+> options = { redirect_uri: `redirect-uri`, client_id: `app-id`, client_secret: `app-secret` }
+> client = Insta::Client.new(options)
+> client.auth_url 
+    # output: 
+    # https://api.instagram.com/oauth/authorize?client_id=#{client_id}&redirect_uri=#{redirect_uri}&scope=#{scope}&response_type=code
+```
+Authenticate your Instagram user by signing into the Authorization Window, then click Authorize to grant your app access to your profile data. Upon success, the page will redirect you to the redirect URI you included in the previous step and append an Authorization Code. For example:
 
-## Development
+`https://socialsizzle.herokuapp.com/auth/?code=AQDp3TtBQQ...#_`
 
-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.
+Note that `#_` has been appended to the end of the redirect URI, but it is not part of the `code` itself. Copy the code (without the `#_` portion) so you can use it in the next step.
 
-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).
+##### Step 2: Exchange the Code for a Token
+code => ....auth/?`code=AQDp3TtBQQ...`#_
+```sh
+> client.access_token(code)
+# output:
+# {
+#    "access_token": "IGQVJ...",
+#    "user_id": 17841405793187218
+# }
+```
+##### Step 3: Exchange a short-lived Instagram User Access Token for a long-lived Instagram User Access Token.
+ long-lived valid only 60day 
+```sh
+    > access_token = "IGQVJ..."
+    > client.long_lived_access_token(access_token)
+    # output:
+    # {
+    #   "access_token": "{access-token}",
+    #   "token_type": "{token-type}",
+    #   "expires_in": {expires-in}
+    # }
+```
 
-## Contributing
+##### Step 4: User Info, Media Data
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/insta. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/insta/blob/master/CODE_OF_CONDUCT.md).
+- create new client
+```sh
+    > require 'insta'
+    > access_token = "IGQVJ..."
+    > client = Insta::API.new(access_token)
+```
+- user info
+```sh
+    > client.me
+```
+- user media
+```sh
+    > client.media
+    > # or
+    > client.media(25)
+    > # for pagination after above method call, run below method for getting next 25 media
+    > client.next_page
+```
 
 
 ## 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 Insta project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/insta/blob/master/CODE_OF_CONDUCT.md).

data/insta.gemspec

@@ -11,6 +11,6 @@ Gem::Specification.new do |s|
   s.files       = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  s.homepage    = 'https://rubygems.org/gems/insta-api'
+  s.homepage    = 'https://github.com/shubhamprajapat1/instagram'
   s.metadata    = { "source_code_uri" => "https://github.com/shubhamprajapat1/instagram" }
 end

data/lib/insta.rb

@@ -69,7 +69,7 @@ module Insta
     end
 
     def media(limit = 100)
-      url = "https://graph.instagram.com/me/media?fields=id,media_type,media_url,username,timestamp&access_token=#{access_token}&limit=#{limit}"
+      url = "https://graph.instagram.com/me/media?fields=id,media_type,caption,permalink,thumbnail_url,media_url,username,timestamp&access_token=#{access_token}&limit=#{limit}"
       response  = get(url)
       puts response.dig('paging', 'next')
       @next_url = response.dig('paging', 'next') unless response.dig('paging', 'next').nil?

data/lib/insta/version.rb

@@ -1,3 +1,3 @@
 module Insta
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: insta-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Shubham Prajapat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-15 00:00:00.000000000 Z
+date: 2020-08-16 00:00:00.000000000 Z
 dependencies: []
 description: The Instagram Basic Display API allows users of your app to get basic
   profile information, photos, and videos in their Instagram accounts.
@@ -25,10 +25,11 @@ files:
 - bin/console
 - bin/setup
 - insta-0.1.0.gem
+- insta-api-0.1.0.gem
 - insta.gemspec
 - lib/insta.rb
 - lib/insta/version.rb
-homepage: https://rubygems.org/gems/insta-api
+homepage: https://github.com/shubhamprajapat1/instagram
 licenses:
 - MIT
 metadata: