instagram_api_client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64ea4b37b0138bbd3d2c8da8f47db69ae42a94b9
-  data.tar.gz: ee8af806017b7327754a832edf711ca4117cb004
+  metadata.gz: 887baccb0b7d3120a0ee92699dcd921b4c570b72
+  data.tar.gz: 814b97dfe0ed9fa03a0288083eca1d9ab40d3619
 SHA512:
-  metadata.gz: 5fcb4202fd585628871edf2fa4637029c7767d57e9a7d646f0b8cb0758147f8a1235cc1ba0f557778d536c0571dcd40cda1f1be42802b9f0ce7dd82d5cf1f22e
-  data.tar.gz: 7829f62adf748a4ec94b914f57cdd740803d70d94c69bfccc81e0a9a0a62871b3c2b26bedf31a0802fe4717ad587ff7919ab549e37cff6d500a91b8a6696b444
+  metadata.gz: 4914cbf47863676d499ed7cc7373cab55fef640358d0d2c6abcca69112d7459a639557cb0e1a711f23cdce7cc6249d51b6925c27704d03635f0330a5b107e582
+  data.tar.gz: bf86c1804a3e89fe4028413354dd88d303f811746bcdd6954e1deed75b2ab38d520051917ff29fb60b6e4b79045a8f4ae46b4f3ca94763881915de9cf0e2997f

data/README.md

@@ -1,4 +1,4 @@
-[![License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/agilie/GoButton)
+[![License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/agilie/instagram_api_gem)
 
 # InstagramApi
 
@@ -8,7 +8,7 @@ You can see the api endpoints here https://www.instagram.com/developer/endpoints
 ## Installation
 
 ```ruby
-gem install instagram_api
+gem install instagram_api_client
 ```
 
 ## Usage
@@ -26,6 +26,66 @@ As for now Instagram access token doesn't change or expire, so you can use this
 to generate it http://services.chrisriversdesign.com/instagram-token/
 I the nearest future the OAuth authorization for access token fetching will be implemented.
 
+The main module of the gem is `InstagramAPI`. It provides a series of methods, regarding each Instagram resource. They are: 
+`Users`, `Media`, `Comments`, `Likes`, `Tags` and `Locations`. So the `Users` resource methods can be accessed by `InstagramAPI.user`
+method, `Tags` by `InstagramAPI.tag` and so on.
+
+The main methods of each resource are `show`, `index`, `create`, `destroy` and `search`. The methods and API endpoints 
+correspondence is as follows 
+
+ |    |    | 
+ | -------- | ----- | 
+ |  **User Resource** |  | 
+ |  InstagramAPI.user.show | GET /users/self | 
+ |  InstagramAPI.user(**user_id**).show | GET /users/**user_id** | 
+ |  InstagramAPI.user.recent_media | GET /users/self/media/recent | 
+ |  InstagramAPI.user(**user_id**).recent_media | GET /users/**user_id**/media/recent | 
+ |  InstagramAPI.user.liked_media | GET /users/self/media/liked | 
+ |  InstagramAPI.user.search(**search_query**) | GET /users/search | 
+ |  *Relationship Endpoints block* |  | 
+ |  InstagramAPI.user.follows | GET /users/self/follows | 
+ |  InstagramAPI.user.followed_by | GET /users/self/followed-by | 
+ |  InstagramAPI.user.requested_by | GET /users/self/requested-by | 
+ |  InstagramAPI.user.check_relationship(**user_id**) | GET /users/**user_id**/relathionship | 
+ |  InstagramAPI.user.change_relationship(**user_id**) | POST /users/**user_id**/relathionship | 
+ |  **Media Resource** |  | 
+ |  InstagramAPI.media(**media_id**).show | GET /media/**media_id** | 
+ |  InstagramAPI.media.short_code(**short_code**) | GET /media/shortcode/**shortcode** | 
+ |  InstagramAPI.media.search(**search_query**) | GET /media/search | 
+ |  *Likes Endpoints block* |  | 
+ |  InstagramAPI.media(media_id).likes | GET /media/**media_id**/likes | 
+ |  InstagramAPI.media(media_id).add_like | POST /media/**media_id**/likes | 
+ |  InstagramAPI.media(media_id).delete_like | DELETE /media/**media_id**/likes | 
+ |  *Comment Endpoints block* |  | 
+ |  InstagramAPI.media(media_id).comments | GET /media/**media_id**/comments | 
+ |  InstagramAPI.media(media_id).add_comment | POST /media/**media_id**/comments | 
+ |  InstagramAPI.media(media_id).delete_comment(**comment_id**) | DELETE /media/**media_id**/comments/**comment_id** | 
+ |  **Tag Resource** |  | 
+ |  InstagramAPI.tag(**tag_name**).show | GET /tags/**tag_name** | 
+ |  InstagramAPI.tag(**tag_name**).recent_media | GET /tags/**tag_name**/media/recent | 
+ |  InstagramAPI.tag.search(**search_query**) | GET /tags/search | 
+ |  **Location Resource** |  | 
+ |  InstagramAPI.location(**location_id**).show | GET /locations/**location_id** | 
+ |  InstagramAPI.location(**location_id**).recent_media | GET /locations/**location_id**/media/recent | 
+ |  InstagramAPI.location.search(**search_query**) | GET /locations/search | 
+
+Each method from the list above accepts a hash as a second argument with additional params according to official 
+[instagram developers documentation](https://www.instagram.com/developer/endpoints/) i.e.
+
+```ruby
+InstagramAPI.user.search('mell', {count: 10})
+InstagramAPI.user('my_user_id').recent_media({min_id: '22721881'})
+```
+
+Search method can get either a query string or a hash. It depends on API requirements, i.e.
+```ruby
+InstagramAPI.user.search('mell')
+InstagramAPI.location.search({lat: 33.10, lng: 15.40})
+```
+
+Response is a `Hashie::Mash` object
+
+
 ## TODOS
 
 1. OAuth authorization for access token fetching
@@ -39,7 +99,7 @@ the solution or create an new issue that we will fix asap. Feel free to contribu
 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))
+This gem is open-sourced by [Agilie Team](https://www.agilie.com?utm_source=github&utm_medium=referral&utm_campaign=Git_Ruby&utm_term=instagram_api_gem) ([info@agilie.com](mailto:info@agilie.com))
 
 ## Contributor
 [Sergey Mell](https://github.com/SergeyMell)
@@ -52,5 +112,5 @@ We will continue publishing new open-source projects. Stay with us, more updates
 
 ## License
 
-The gem is available as open source under the [MIT](LICENSE.md) License (MIT) Copyright © 2017 [Agilie Team](https://www.agilie.com)
+The gem is available as open source under the [MIT](LICENSE.md) License (MIT) Copyright © 2017 [Agilie Team](https://www.agilie.com?utm_source=github&utm_medium=referral&utm_campaign=Git_Ruby&utm_term=instagram_api_gem)
 

data/instagram_api.gemspec

@@ -6,8 +6,8 @@ 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.authors       = ['Sergey Mell', 'Agilie Team']
+  spec.email         = ['sergey.mell@agilie.com', 'web@agilie.com']
 
   spec.summary       = 'A Ruby wrapper for the Instagram API'
   spec.description   = 'A Ruby wrapper for the Instagram API'

data/lib/instagram_api/common.rb

@@ -6,7 +6,8 @@ module InstagramApi
     include Client
 
     def search(query, options = {})
-      make_request resource_path('search'), query: options.merge(q: query)
+      options = query.is_a?(Hash) ? options.merge(query) : options.merge(q: query)
+      make_request resource_path('search'), query: options
     end
   end
 

data/lib/instagram_api/location.rb

@@ -4,11 +4,16 @@ module InstagramApi
 
   class Location
     include Search
+    include Resource
 
     def initialize(location_id = nil)
       @location_id = location_id
     end
 
+    def show
+      super @location_id
+    end
+
     def recent_media(options = {})
       index @location_id, 'media/recent', options
     end

data/lib/instagram_api/tag.rb

@@ -10,6 +10,10 @@ module InstagramApi
       @tag_id = tag_id
     end
 
+    def show
+      super @tag_id
+    end
+
     def recent_media(options = {})
       index @tag_id, 'media/recent', options
     end

data/lib/instagram_api/user.rb

@@ -30,6 +30,10 @@ module InstagramApi
       make_request resource_path('self/followed-by'), query: options
     end
 
+    def requested_by(options = {})
+      make_request resource_path('self/requested-by'), query: options
+    end
+
     def check_relationship(user_id, options = {})
       make_request resource_path("#{user_id}/relationship"), query: options
     end

data/lib/instagram_api/version.rb

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

metadata

@@ -1,10 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: instagram_api_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
-- SergeyMell
+- Sergey Mell
+- Agilie Team
 autorequire: 
 bindir: exe
 cert_chain: []
@@ -97,6 +98,7 @@ dependencies:
 description: A Ruby wrapper for the Instagram API
 email:
 - sergey.mell@agilie.com
+- web@agilie.com
 executables: []
 extensions: []
 extra_rdoc_files: []