social_net 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73b6da8b92cf24696015cda1d38891a6fb043297
-  data.tar.gz: 28c123c06bd4e0262576075b85d67c45dbcf2425
+  metadata.gz: d377f2038172fd76217e4af11f4529fe4635fc54
+  data.tar.gz: d0dd25976061611f287fa340e092465f6146ae8d
 SHA512:
-  metadata.gz: 1ec0e9c88456a8a6919f45bce23005ac44a1b14d542cdb4372613f8b218a898c310e535d2cd5ce8b80fefa212515de1b386e370036f5dff76830b4f2abff354d
-  data.tar.gz: 355ef7c86b0b08e2348f397ae0c0dc458b59882ad395e6e7c536cfa501c386dc2545185286f38dfb0f199a761b048e6c0101f421391889e84de11c1774d508e4
+  metadata.gz: e79cb37ae71a214c5440efd7b56c9c35e7e51bba4ccfda16eb4f8be9dfcde2679f5d50ef413b920d70f16f4b9a9f1bb02b6b5c2c44106427fdbfa801fa6b9330
+  data.tar.gz: 098b3b67bb8016f108b2fd94f535ebbb945fe929ddb874ab692ec5c937717edf120c443857157d7f5eb95cecfdbbbba53b7f024714e41da768b254864abcde70

data/CHANGELOG.md

@@ -25,3 +25,7 @@ For more information about changelogs, check
 ## 0.2.6 - 2017-5-31
 
 * [BUGFIX] Add missing tests and errors for a private Instagram user.
+
+## 0.2.7 - 2017-7-26
+
+* [FEATURE] Add `Instagram::Video` support for `find_by media_id:` and `find_by! media_id:`

data/README.md

@@ -99,6 +99,16 @@ user.videos #=>
   #   @thumbnail='https://scontent.cdninstagram.com/t51.2885-15/e15/17076697_308353549580106_8220285822193106944_n.jpg']"
 ```
 
+Use [SocialNet::Instagram::Video]() to:
+
+* retrieve an Instagram video by media id
+
+```ruby
+video = SocialNet::Instagram::Video.find_by media_id: '1531332985868221389'
+video.link #=> 'https://www.instagram.com/p/BVAYzy_g3vN/'
+video.file #=> 'https://scontent.cdninstagram.com/t50.2886-16/18954088_1445442168855176_8271610702855143424_n.mp4'
+```
+
 *The methods above require a configured Instagram app (see below).*
 
 SocialNet::Facebook::Page

data/lib/social_net/instagram/api/request.rb

@@ -15,7 +15,7 @@ module SocialNet
         end
 
         def run
-          #print "#{as_curl}\n"
+          print "#{as_curl}\n"
           case response = run_http_request
           when Net::HTTPOK
             JSON(response.body)['data']

data/lib/social_net/instagram/errors/unknown_video.rb

@@ -0,0 +1,11 @@
+module SocialNet
+  module Instagram
+    module Errors
+      class UnknownVideo < StandardError
+        def message
+          'Unknown video'
+        end
+      end
+    end
+  end
+end

data/lib/social_net/instagram/errors.rb

@@ -1,3 +1,4 @@
 require 'social_net/instagram/errors/response_error'
 require 'social_net/instagram/errors/unknown_user'
 require 'social_net/instagram/errors/private_user'
+require 'social_net/instagram/errors/unknown_video'

data/lib/social_net/instagram/models/video.rb

@@ -1,3 +1,6 @@
+require 'social_net/instagram/api/request'
+require 'social_net/instagram/errors'
+
 module SocialNet
   module Instagram
     module Models
@@ -12,6 +15,44 @@ module SocialNet
           @thumbnail = attrs['images']['standard_resolution']['url']
           @link = attrs['link']
         end
+
+        # Returns the existing Instagram video matching the provided attributes or
+        # nil when the video is not found.
+        #
+        # @return [SocialNet::Instagram::Models::Video] when the video is found.
+        # @return [nil] when the video is not found.
+        # @param [Hash] params the attributes to find a video by.
+        # @option params [String] :media_id The Instagram video's media id.
+        def self.find_by(params = {})
+          find_by! params
+        rescue Errors::UnknownVideo
+          nil
+        end
+
+        # Returns the existing Instagram video matching the provided attributes or
+        # raises an error when the video is not found.
+        #
+        # @return [SocialNet::Instagram::Models::Video] when the video is found.
+        # @return [nil] when the video is not found.
+        # @param [Hash] params the attributes to find a video by.
+        # @option params [String] :media_id The Instagram video's media id.
+        # @raise [SocialNet::Errors::UnknownVideo] if the video is not found.
+        def self.find_by!(params = {})
+          if params[:media_id]
+            find_by_id! params[:media_id]
+          end
+        end
+
+        private
+
+        def self.find_by_id!(id)
+          request = Api::Request.new endpoint: "media/#{id}"
+          new request.run
+        rescue Errors::ResponseError => error
+          case error.response
+            when Net::HTTPBadRequest then raise Errors::UnknownVideo
+          end
+        end
       end
     end
   end

data/lib/social_net/version.rb

@@ -1,3 +1,3 @@
 module SocialNet
-  VERSION = "0.2.6"
+  VERSION = "0.2.7"
 end

data/spec/social_net/instagram/models/video_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'social_net/instagram'
+
+describe SocialNet::Instagram::Video, :vcr do
+  before :all do
+    SocialNet::Instagram.configure do |config|
+      if config.access_token.blank?
+        config.access_token = 'ACCESS_TOKEN'
+      end
+    end
+  end
+
+  let(:existing_media_id) { '1531332985868221389' }
+  let(:unknown_media_id) { '31231231231231232' }
+
+  describe '.find_by' do
+    subject(:video) { SocialNet::Instagram::Video.find_by media_id: media_id }
+
+    context 'given an existing video\'s media id' do
+      let(:media_id) { existing_media_id }
+
+      it 'returns an object representing that video' do
+        expect(video.id).to eq '1531332985868221389_2920261222'
+        expect(video.link).to eq 'https://www.instagram.com/p/BVAYzy_g3vN/'
+      end
+    end
+
+    context 'given a nonexistant video' do
+      let(:media_id) { unknown_media_id }
+      it { expect(video).to be_nil }
+    end
+  end
+
+  describe '.find_by!' do
+    subject(:video) { SocialNet::Instagram::Video.find_by! media_id: media_id }
+
+    context 'given an existing video\'s media id' do
+      let(:media_id) { existing_media_id }
+
+      it 'returns an object representing that video' do
+        expect(video.id).to eq '1531332985868221389_2920261222'
+        expect(video.link).to eq 'https://www.instagram.com/p/BVAYzy_g3vN/'
+      end
+    end
+
+    context 'given a nonexistant video' do
+      let(:media_id) { unknown_media_id }
+      it { expect{video}.to raise_error SocialNet::Instagram::UnknownVideo }
+    end
+  end
+end

data/spec/support/cassettes/SocialNet_Instagram_Models_Video/_find_by/given_a_nonexistant_video/.yml

@@ -0,0 +1,53 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.instagram.com/v1/media/31231231231231232?access_token=INSTAGRAM_ACCESS_TOKEN
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ratelimit-Limit:
+      - '5000'
+      X-Ratelimit-Remaining:
+      - '4965'
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      Pragma:
+      - no-cache
+      Expires:
+      - Sat, 01 Jan 2000 00:00:00 GMT
+      Vary:
+      - Cookie, Accept-Language
+      Content-Language:
+      - en
+      Date:
+      - Wed, 26 Jul 2017 23:54:13 GMT
+      Set-Cookie:
+      - csrftoken=j41eKlQbLj0zVbPl8wuhhy59nkmzQR7X; expires=Wed, 25-Jul-2018 23:54:13
+        GMT; Max-Age=31449600; Path=/; Secure
+      - rur=FTW; Path=/
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '94'
+    body:
+      encoding: UTF-8
+      string: '{"meta": {"code": 400, "error_type": "APINotFoundError", "error_message":
+        "invalid media id"}}'
+    http_version: 
+  recorded_at: Wed, 26 Jul 2017 23:54:13 GMT
+recorded_with: VCR 2.9.3

data/spec/support/cassettes/SocialNet_Instagram_Models_Video/_find_by/given_an_existing_video_s_media_id/returns_an_object_representing_that_video.yml

@@ -0,0 +1,69 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.instagram.com/v1/media/1531332985868221389?access_token=INSTAGRAM_ACCESS_TOKEN
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ratelimit-Limit:
+      - '5000'
+      X-Ratelimit-Remaining:
+      - '4966'
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      Pragma:
+      - no-cache
+      Expires:
+      - Sat, 01 Jan 2000 00:00:00 GMT
+      Vary:
+      - Cookie, Accept-Language, Accept-Encoding
+      Content-Language:
+      - en
+      Date:
+      - Wed, 26 Jul 2017 23:54:13 GMT
+      Set-Cookie:
+      - csrftoken=Wup5cI7PHEwOEWvIGvzpsEx5Rgp9LSrp; expires=Wed, 25-Jul-2018 23:54:13
+        GMT; Max-Age=31449600; Path=/; Secure
+      - rur=FTW; Path=/
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '702'
+    body:
+      encoding: ASCII-8BIT
+      string: '{"data": {"id": "1531332985868221389_2920261222", "user": {"id": "2920261222",
+        "full_name": "EjamBrocolli", "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/s150x150/20181021_187099138494103_2678022811838054400_a.jpg",
+        "username": "ejamtucker"}, "images": {"thumbnail": {"width": 150, "height":
+        150, "url": "https://scontent.cdninstagram.com/t51.2885-15/s150x150/e15/18948059_1942577789357229_5999747679591071744_n.jpg"},
+        "low_resolution": {"width": 320, "height": 320, "url": "https://scontent.cdninstagram.com/t51.2885-15/s320x320/e15/18948059_1942577789357229_5999747679591071744_n.jpg"},
+        "standard_resolution": {"width": 640, "height": 640, "url": "https://scontent.cdninstagram.com/t51.2885-15/e15/18948059_1942577789357229_5999747679591071744_n.jpg"}},
+        "created_time": "1496769139", "caption": {"id": "17871224890103184", "text":
+        "Yesterday Hit Me Hard \ud83c\udf51 #skate.my #Hallofmeat (Cukup Lah Ni Makanan
+        Sahur)", "created_time": "1496769139", "from": {"id": "2920261222", "full_name":
+        "EjamBrocolli", "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/s150x150/20181021_187099138494103_2678022811838054400_a.jpg",
+        "username": "ejamtucker"}}, "user_has_liked": false, "likes": {"count": 112},
+        "tags": ["hallofmeat", "skate"], "filter": "Normal", "comments": {"count":
+        17}, "type": "video", "link": "https://www.instagram.com/p/BVAYzy_g3vN/",
+        "location": null, "attribution": null, "users_in_photo": [], "videos": {"standard_resolution":
+        {"width": 640, "height": 640, "url": "https://scontent.cdninstagram.com/t50.2886-16/18954088_1445442168855176_8271610702855143424_n.mp4"},
+        "low_bandwidth": {"width": 480, "height": 480, "url": "https://scontent.cdninstagram.com/t50.2886-16/18928806_320856988345914_4131951279704375296_n.mp4"},
+        "low_resolution": {"width": 480, "height": 480, "url": "https://scontent.cdninstagram.com/t50.2886-16/18928806_320856988345914_4131951279704375296_n.mp4"}}},
+        "meta": {"code": 200}}'
+    http_version: 
+  recorded_at: Wed, 26 Jul 2017 23:54:13 GMT
+recorded_with: VCR 2.9.3

data/spec/support/cassettes/SocialNet_Instagram_Models_Video/_find_by_/given_a_nonexistant_video/.yml

@@ -0,0 +1,53 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.instagram.com/v1/media/31231231231231232?access_token=INSTAGRAM_ACCESS_TOKEN
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ratelimit-Limit:
+      - '5000'
+      X-Ratelimit-Remaining:
+      - '4963'
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      Pragma:
+      - no-cache
+      Expires:
+      - Sat, 01 Jan 2000 00:00:00 GMT
+      Vary:
+      - Cookie, Accept-Language
+      Content-Language:
+      - en
+      Date:
+      - Wed, 26 Jul 2017 23:54:14 GMT
+      Set-Cookie:
+      - csrftoken=xIFSTEGyONB8IpDt7S1nEWUSvWovvWJp; expires=Wed, 25-Jul-2018 23:54:14
+        GMT; Max-Age=31449600; Path=/; Secure
+      - rur=FTW; Path=/
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '94'
+    body:
+      encoding: UTF-8
+      string: '{"meta": {"code": 400, "error_type": "APINotFoundError", "error_message":
+        "invalid media id"}}'
+    http_version: 
+  recorded_at: Wed, 26 Jul 2017 23:54:14 GMT
+recorded_with: VCR 2.9.3

data/spec/support/cassettes/SocialNet_Instagram_Models_Video/_find_by_/given_an_existing_video_s_media_id/returns_an_object_representing_that_video.yml

@@ -0,0 +1,69 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.instagram.com/v1/media/1531332985868221389?access_token=INSTAGRAM_ACCESS_TOKEN
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ratelimit-Limit:
+      - '5000'
+      X-Ratelimit-Remaining:
+      - '4964'
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      Pragma:
+      - no-cache
+      Expires:
+      - Sat, 01 Jan 2000 00:00:00 GMT
+      Vary:
+      - Cookie, Accept-Language, Accept-Encoding
+      Content-Language:
+      - en
+      Date:
+      - Wed, 26 Jul 2017 23:54:13 GMT
+      Set-Cookie:
+      - csrftoken=xKRuZk6RsOUSQn97DtfuDRTUnirdrFVa; expires=Wed, 25-Jul-2018 23:54:13
+        GMT; Max-Age=31449600; Path=/; Secure
+      - rur=FTW; Path=/
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '702'
+    body:
+      encoding: ASCII-8BIT
+      string: '{"data": {"id": "1531332985868221389_2920261222", "user": {"id": "2920261222",
+        "full_name": "EjamBrocolli", "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/s150x150/20181021_187099138494103_2678022811838054400_a.jpg",
+        "username": "ejamtucker"}, "images": {"thumbnail": {"width": 150, "height":
+        150, "url": "https://scontent.cdninstagram.com/t51.2885-15/s150x150/e15/18948059_1942577789357229_5999747679591071744_n.jpg"},
+        "low_resolution": {"width": 320, "height": 320, "url": "https://scontent.cdninstagram.com/t51.2885-15/s320x320/e15/18948059_1942577789357229_5999747679591071744_n.jpg"},
+        "standard_resolution": {"width": 640, "height": 640, "url": "https://scontent.cdninstagram.com/t51.2885-15/e15/18948059_1942577789357229_5999747679591071744_n.jpg"}},
+        "created_time": "1496769139", "caption": {"id": "17871224890103184", "text":
+        "Yesterday Hit Me Hard \ud83c\udf51 #skate.my #Hallofmeat (Cukup Lah Ni Makanan
+        Sahur)", "created_time": "1496769139", "from": {"id": "2920261222", "full_name":
+        "EjamBrocolli", "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/s150x150/20181021_187099138494103_2678022811838054400_a.jpg",
+        "username": "ejamtucker"}}, "user_has_liked": false, "likes": {"count": 112},
+        "tags": ["skate", "hallofmeat"], "filter": "Normal", "comments": {"count":
+        17}, "type": "video", "link": "https://www.instagram.com/p/BVAYzy_g3vN/",
+        "location": null, "attribution": null, "users_in_photo": [], "videos": {"standard_resolution":
+        {"width": 640, "height": 640, "url": "https://scontent.cdninstagram.com/t50.2886-16/18954088_1445442168855176_8271610702855143424_n.mp4"},
+        "low_bandwidth": {"width": 480, "height": 480, "url": "https://scontent.cdninstagram.com/t50.2886-16/18928806_320856988345914_4131951279704375296_n.mp4"},
+        "low_resolution": {"width": 480, "height": 480, "url": "https://scontent.cdninstagram.com/t50.2886-16/18928806_320856988345914_4131951279704375296_n.mp4"}}},
+        "meta": {"code": 200}}'
+    http_version: 
+  recorded_at: Wed, 26 Jul 2017 23:54:13 GMT
+recorded_with: VCR 2.9.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: social_net
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Jeremy Cohen Hoffing
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-31 00:00:00.000000000 Z
+date: 2017-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -154,6 +154,7 @@ files:
 - lib/social_net/instagram/errors/private_user.rb
 - lib/social_net/instagram/errors/response_error.rb
 - lib/social_net/instagram/errors/unknown_user.rb
+- lib/social_net/instagram/errors/unknown_video.rb
 - lib/social_net/instagram/models.rb
 - lib/social_net/instagram/models/user.rb
 - lib/social_net/instagram/models/video.rb
@@ -173,6 +174,7 @@ files:
 - spec/social_net/facebook/models/pages_spec.rb
 - spec/social_net/facebook/models/users_spec.rb
 - spec/social_net/instagram/models/user_spec.rb
+- spec/social_net/instagram/models/video_spec.rb
 - spec/social_net/twitter/models/user_spec.rb
 - spec/spec_helper.rb
 - spec/support/cassettes/Posts/_posts/given_an_existing_case-insensitive_username/returns_an_object_representing_that_user.yml
@@ -183,6 +185,10 @@ files:
 - spec/support/cassettes/SocialNet_Instagram_Models_User/_find_by_/given_an_existing_case-insensitive_username/returns_an_object_representing_that_user.yml
 - spec/support/cassettes/SocialNet_Instagram_Models_User/_find_by_/given_an_unknown_username/.yml
 - spec/support/cassettes/SocialNet_Instagram_Models_User/_videos/given_an_existing_user/returns_an_array_of_video_posts_from_the_user.yml
+- spec/support/cassettes/SocialNet_Instagram_Models_Video/_find_by/given_a_nonexistant_video/.yml
+- spec/support/cassettes/SocialNet_Instagram_Models_Video/_find_by/given_an_existing_video_s_media_id/returns_an_object_representing_that_video.yml
+- spec/support/cassettes/SocialNet_Instagram_Models_Video/_find_by_/given_a_nonexistant_video/.yml
+- spec/support/cassettes/SocialNet_Instagram_Models_Video/_find_by_/given_an_existing_video_s_media_id/returns_an_object_representing_that_video.yml
 - spec/support/vcr.rb
 homepage: https://github.com/CollabCreators/social_net
 licenses:
@@ -212,6 +218,7 @@ test_files:
 - spec/social_net/facebook/models/pages_spec.rb
 - spec/social_net/facebook/models/users_spec.rb
 - spec/social_net/instagram/models/user_spec.rb
+- spec/social_net/instagram/models/video_spec.rb
 - spec/social_net/twitter/models/user_spec.rb
 - spec/spec_helper.rb
 - spec/support/cassettes/Posts/_posts/given_an_existing_case-insensitive_username/returns_an_object_representing_that_user.yml
@@ -222,5 +229,9 @@ test_files:
 - spec/support/cassettes/SocialNet_Instagram_Models_User/_find_by_/given_an_existing_case-insensitive_username/returns_an_object_representing_that_user.yml
 - spec/support/cassettes/SocialNet_Instagram_Models_User/_find_by_/given_an_unknown_username/.yml
 - spec/support/cassettes/SocialNet_Instagram_Models_User/_videos/given_an_existing_user/returns_an_array_of_video_posts_from_the_user.yml
+- spec/support/cassettes/SocialNet_Instagram_Models_Video/_find_by/given_a_nonexistant_video/.yml
+- spec/support/cassettes/SocialNet_Instagram_Models_Video/_find_by/given_an_existing_video_s_media_id/returns_an_object_representing_that_video.yml
+- spec/support/cassettes/SocialNet_Instagram_Models_Video/_find_by_/given_a_nonexistant_video/.yml
+- spec/support/cassettes/SocialNet_Instagram_Models_Video/_find_by_/given_an_existing_video_s_media_id/returns_an_object_representing_that_video.yml
 - spec/support/vcr.rb
 has_rdoc: