social_net 0.2.19 → 0.2.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbbfd05e27a93524f64a2446337cac22a4208555a42fe72c38f1a663dd7cca5f
-  data.tar.gz: cefc2822c9bb415800bee5012411fac8e4c99a7f395e47c9455a8c7dc40d366d
+  metadata.gz: e8f46909af7e663139816f04602accdab974ff58f69f2a12dbc0f070b43de3d2
+  data.tar.gz: a5045b140e87e1aedac869ce985ca80e6e694cdff52a9c9e4c6c513c0d0282e5
 SHA512:
-  metadata.gz: 21f46409ba3b87d65c9327934ad75a1c7125727f8baf45f68fda0cdebf1f5c5fd8492c264e12677f1a66ea4723dabf055756853b7c822dc57cd343d7fcd5a62b
-  data.tar.gz: a9b9753758d2096c3846c4bffb63ceb70dba9dfa308be9caf5d70984c20289485d51b49344496a3b51afe8f48ce526f2967943c3b27ac0bb80189dd0543a08f7
+  metadata.gz: 4e744faaf31d17afaca10e52e588609d63a9554c41fac6716bec42f9af0dd3a602aee7a94ba51c85774125f7ed138594aa49637afca5faa2fa606e52d1cbc956
+  data.tar.gz: 0ad5e30ada6dc472a0c91cdded05584d58c54b0e451656bc4c0ab3867cb8d78aef001f4b165177c131083c886aefffe5fb14187fbcf86bcceabbdf90cd7103e3

data/README.md

@@ -1,9 +1,17 @@
 SocialNet - a Ruby client for social networks API
 ===========================================
 
-SocialNet helps you write apps that need to interact with Twitter, Instagram and Facebook.
+SocialNet helps you write apps that need to interact with Instagram, Byte, Twitter, and Facebook.
 
-## Note: Only Instagram works at the moment
+## Note: Only Instagram and Byte works at the moment
+
+After [configuring your Byte app](#configuring-your-byte-app), you can run commands like:
+
+```ruby
+user = SocialNet::Byte::User.find_by username: 'ollie'
+user.username #=> "ollie"
+user.follower_count #=> 300
+```
 
 After [configuring your Twitter app](#configuring-your-twitter-app), you can run commands like:
 
@@ -115,6 +123,65 @@ video.link #=> 'https://www.instagram.com/p/BW-nC7xg8ZX/'
 video.file #=> 'https://scontent.cdninstagram.com/t50.2886-16/20372137_156190564936990_2601958215176421376_n.mp4'
 ```
 
+SocialNet::Byte::User
+--------------------
+
+Use [SocialNet::Byte::User]() to:
+
+* retrieve a Byte user by username
+* retrieve a Byte user by id
+* retrieve posts of a Byte user
+
+```ruby
+user = SocialNet::Byte::User.find_by username: 'ollie'
+user.follower_count #=> 0
+
+user = SocialNet::Byte::User.find_by id: 'PUEMKGYDBFAZ3HSRSAFGBAI5HA'
+user.follower_count #=> 0
+
+user.posts #=>
+ # {:posts=>
+ # [#<SocialNet::Byte::Models::Post:0x00007fb71b8705a8
+ #  @author_id="PUEMKGYDBFAZ3HSRSAFGBAI5HA",
+ #  @caption="i’m in ya house (ft. @Tishsimmonds)",
+ #  @category="comedy",
+ #  @comment_count=110,
+ #  @date=1580391236,
+ #  @id="WZPPQ5LQJZAAHP4BWFLM6PRBNM",
+ #  @like_count=2439,
+ #  @loop_count=34891,
+ #  @thumb_src="https://e6k9t9a9.stackpathcdn.com/videos/5VVTQ4TTZBCRRHWDUPIZNUWDKM.jpg",
+ #  @video_src="https://e6k9t9a9.stackpathcdn.com/videos/5VVTQ4TTZBCRRHWDUPIZNUWDKM-h264.mp4">],
+ # :next_page=>"CXWZB7CTMYLTA"}
+
+user.posts(next_page: 'CXWZB7CTMYLTA') #=>
+  # {:posts=>
+  # [#<SocialNet::Byte::Models::Post:0x00007fb718468788
+  #  @author_id="PUEMKGYDBFAZ3HSRSAFGBAI5HA",
+  #  @caption="pov of a hungry person thinking byte is a delivery food app",
+  #  @category="comedy",
+  #  @comment_count=95,
+  #  @date=1580043689,
+  #  @id="PNHNHKO3RZF2HJVHSD64V4X3LE",
+  #  @like_count=2605,
+  #  @loop_count=23982,
+  #  @share_url="https://byte.co/b/B69eUGbPcDM",
+  #  @thumb_src="https://e6k9t9a9.stackpathcdn.com/videos/XRIRCMQZGBAUDLCWUJQPHGYYEE.jpg",
+  #  @video_src="https://e6k9t9a9.stackpathcdn.com/videos/XRIRCMQZGBAUDLCWUJQPHGYYEE-h264.mp4">,
+  # :next_page=>"CXWPROPUQCCNQ"}
+```
+
+Use [SocialNet::Byte::Post]() to:
+
+* retrieve a Byte post by id
+
+```ruby
+post = SocialNet::Byte::Post.find_by id: 'WZPPQ5LQJZAAHP4BWFLM6PRBNM'
+
+post.caption #=> "i’m in ya house (ft. @Tishsimmonds)"
+post.video_src #=> "https://e6k9t9a9.stackpathcdn.com/videos/5VVTQ4TTZBCRRHWDUPIZNUWDKM-h264.mp4"
+```
+
 SocialNet::Facebook::Page
 --------------------
 
@@ -223,6 +290,40 @@ end
 so use the approach that you prefer.
 If a variable is set in both places, then `SocialNet::Instagram.configure` takes precedence.
 
+Configuring your Byte app
+============================
+
+Once the app is created, copy your access token and add it to your
+code with the following snippet of code (replacing with your own access token)
+:
+
+```ruby
+SocialNet::Byte.configure do |config|
+  config.access_token = 'abcdefg'
+end
+```
+
+Configuring with environment variables
+--------------------------------------
+
+As an alternative to the approach above, you can configure your app with
+a variable. Setting the following environment variable:
+
+```bash
+export BYTE_ACCESS_TOKEN='abcdefg'
+```
+
+is equivalent to configuring your app with the initializer:
+
+```ruby
+SocialNet::Byte.configure do |config|
+  config.access_token = 'abcdefg'
+end
+```
+
+so use the approach that you prefer.
+If a variable is set in both places, then `SocialNet::Byte.configure` takes precedence.
+
 Configuring your Facebook app
 ============================
 

data/lib/social_net/byte/api/configuration.rb

@@ -0,0 +1,13 @@
+module SocialNet
+  module Byte
+    module Api
+      class Configuration
+        attr_accessor :access_token
+
+        def initialize
+          @access_token = ENV['BYTE_ACCESS_TOKEN']
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+require 'social_net/byte/errors/response_error'
+require 'social_net/byte/errors/unknown_user'
+require 'active_support'
+require 'active_support/core_ext'
+
+module SocialNet
+  module Byte
+    module Api
+      class Request
+        def initialize(attrs = {})
+          @host = 'api.byte.co'
+          @username = attrs[:username]
+          @endpoint = attrs.fetch :endpoint, "/account/id/#{@username}/posts"
+          @block = attrs.fetch :block, -> (request) {add_access_token_and_cursor! request}
+          @next_page = attrs[:next_page] if attrs[:next_page]
+          @method = attrs.fetch :method, :get
+        end
+
+        def run
+          print "#{as_curl}\n"
+          case response = run_http_request
+          when Net::HTTPOK
+            JSON response.body
+          else
+            raise Errors::ResponseError, response
+          end
+        end
+
+        private
+
+        def run_http_request
+          Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+            http.request http_request
+          end
+        end
+
+        def http_request
+          http_class = "Net::HTTP::#{@method.capitalize}".constantize
+          @http_request ||= http_class.new(uri.request_uri).tap do |request|
+            @block.call request
+          end
+        end
+
+        def uri
+          @uri ||= URI::HTTPS.build host: @host, path: @endpoint, query: query
+        end
+
+        def add_access_token_and_cursor!(request)
+          request.add_field 'Authorization', SocialNet::Byte.configuration.access_token
+        end
+
+        def query
+          {}.tap do |query|
+            query.merge! cursor: @next_page if @next_page
+          end.to_param
+        end
+
+        def as_curl
+          'curl'.tap do |curl|
+            curl <<  " -X #{http_request.method}"
+            http_request.each_header do |name, value|
+              curl << %Q{ -H "#{name}: #{value}"}
+            end
+            curl << %Q{ -d '#{http_request.body}'} if http_request.body
+            curl << %Q{ "#{@uri.to_s}"}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/social_net/byte/config.rb

@@ -0,0 +1,16 @@
+require 'social_net/byte/api/configuration'
+
+module SocialNet
+  module Byte
+    module Config
+      def configure
+        yield configuration if block_given?
+      end
+
+      def configuration
+        @configuration ||= Api::Configuration.new
+      end
+    end
+  end
+end
+

data/lib/social_net/byte/errors/response_error.rb

@@ -0,0 +1,14 @@
+module SocialNet
+  module Byte
+    module Errors
+      class ResponseError < StandardError
+        attr_reader :response
+
+        def initialize(response = {})
+          @response = response
+          super response
+        end
+      end
+    end
+  end
+end

data/lib/social_net/byte/errors/unknown_post.rb

@@ -0,0 +1,11 @@
+module SocialNet
+  module Byte
+    module Errors
+      class UnknownPost < StandardError
+        def message
+          'Unknown post'
+        end
+      end
+    end
+  end
+end

data/lib/social_net/byte/errors/unknown_user.rb

@@ -0,0 +1,11 @@
+module SocialNet
+  module Byte
+    module Errors
+      class UnknownUser < StandardError
+        def message
+          'Unknown user'
+        end
+      end
+    end
+  end
+end

data/lib/social_net/byte/errors.rb

@@ -0,0 +1,3 @@
+require 'social_net/byte/errors/response_error'
+require 'social_net/byte/errors/unknown_user'
+require 'social_net/byte/errors/unknown_post'

data/lib/social_net/byte/models/post.rb

@@ -0,0 +1,66 @@
+require 'social_net/byte/api/request'
+require 'social_net/byte/errors'
+
+module SocialNet
+  module Byte
+    module Models
+      class Post
+        attr_reader :id,
+                    :author_id,
+                    :caption,
+                    :category,
+                    :mentions,
+                    :date,
+                    :video_src,
+                    :thumb_src,
+                    :comment_count,
+                    :comments,
+                    :like_count,
+                    :loop_count
+
+        def initialize(attrs = {})
+          attrs.each{|k, v| instance_variable_set("@#{k}", v) unless v.nil?}
+        end
+
+        # Returns the existing Byte post matching the provided attributes or
+        # nil when the post is not found.
+        #
+        # @return [SocialNet::Byte::Models::post] when the post is found.
+        # @return [nil] when the post is not found.
+        # @param [Hash] params the attributes to find a post by.
+        # @option params [String] :id The Byte post’s id
+        #   (case-insensitive).
+        def self.find_by(params = {})
+          find_by! params
+        rescue Errors::UnknownPost
+          nil
+        end
+
+        # Returns the existing Byte post matching the provided attributes or
+        # nil when the post is not found, and raises an error when the post is not found.
+        #
+        # @return [SocialNet::Byte::Models::Post] the Byte post.
+        # @param [Hash] params the attributes to find a post by.
+        # @option params [String] :id The Byte post id
+        #   (case-sensitive).
+        # @raise [SocialNet::Errors::UnknownPost] if the post is unknown.
+        def self.find_by!(params = {})
+          if params[:id]
+            find_by_id! params[:id]
+          end
+        end
+
+      private
+
+        def self.find_by_id!(id)
+          request = Api::Request.new endpoint: "/post/id/#{id}"
+          if post = request.run['data']
+            new post.deep_transform_keys { |key| key.underscore.to_sym }
+          else
+            raise Errors::UnknownPost
+          end
+        end
+      end
+    end
+  end
+end

data/lib/social_net/byte/models/user.rb

@@ -0,0 +1,99 @@
+require 'social_net/byte/api/request'
+require 'social_net/byte/errors'
+
+module SocialNet
+  module Byte
+    module Models
+      class User
+        attr_reader :id,
+                    :avatar_url,
+                    :bio,
+                    :display_name,
+                    :follower_count,
+                    :following_count,
+                    :username,
+                    :registration_date
+
+        def initialize(attrs = {})
+          attrs.each{|k, v| instance_variable_set("@#{k}", v) unless v.nil?}
+        end
+
+        # Returns the existing Byte user's most recent posts
+        #
+        # @return [SocialNet::Byte::Models::Post] when the posts are found.
+        # @ param [Hash] params the attributes to find paginated posts by.
+        # @option params [String] :next_page The next page of paginated posts.
+        def posts(opts={})
+          params = {endpoint: "/account/id/#{@id}/posts"}.merge! opts
+          request = Api::Request.new params
+          posts_data = request.run
+          {}.tap do |k,v|
+            k[:posts] = posts_data['data']['posts'].map{|post| Post.new post.deep_transform_keys { |key| key.underscore.to_sym }}
+            k[:next_page] = posts_data['data']['cursor']
+          end
+        rescue Errors::ResponseError => error
+          case error.response
+            when Net::HTTPBadRequest then raise Errors::UnknownUser
+            when Net::HTTPNotFound then raise Errors::UnknownUser
+          end
+        end
+
+        # Returns the existing Byte user matching the provided attributes or
+        # nil when the user is not found.
+        #
+        # @return [SocialNet::Byte::Models::User] when the user is found.
+        # @return [nil] when the user is not found.
+        # @param [Hash] params the attributes to find a user by.
+        # @option params [String] :username The Byte user’s username
+        #   (case-insensitive).
+        # @option params [String] :id The Byte user’s id
+        #   (case-insensitive).
+        def self.find_by(params = {})
+          find_by! params
+        rescue Errors::UnknownUser
+          nil
+        end
+
+        # Returns the existing Byte user matching the provided attributes or
+        # nil when the user is not found, and raises an error when the user account is private.
+        #
+        # @return [SocialNet::Byte::Models::User] the Byte user.
+        # @param [Hash] params the attributes to find a user by.
+        # @option params [String] :username The Byte user’s username
+        #   (case-insensitive).
+        # @option params [String] :id The Byte user’s id
+        #   (case-insensitive).
+        # @raise [SocialNet::Errors::UnknownUser] if the user account is unknown.
+        def self.find_by!(params = {})
+          if params[:username]
+            find_by_username! params[:username]
+          elsif params[:id]
+            find_by_id! params[:id]
+          end
+        end
+
+      private
+
+        def self.find_by_username!(username)
+          request = Api::Request.new endpoint: "/account/prefix/#{username}"
+          response = request.run
+          users = response['data']['accounts']
+          if user = users.find{|u| u['username'].casecmp(username).zero?}
+            new user.transform_keys { |key| key.underscore.to_sym }
+          else
+            raise Errors::UnknownUser
+          end
+        end
+
+        def self.find_by_id!(id)
+          request = Api::Request.new endpoint: "/account/id/#{id}"
+          if user = request.run['data']
+            new user.transform_keys { |key| key.underscore.to_sym }
+          else
+            raise Errors::UnknownUser
+          end
+        end
+      end
+    end
+  end
+end

data/lib/social_net/byte/models.rb

@@ -0,0 +1,2 @@
+require 'social_net/byte/models/user'
+require 'social_net/byte/models/post'

data/lib/social_net/byte.rb

@@ -0,0 +1,11 @@
+require 'social_net/byte/config'
+require 'social_net/byte/models'
+require 'social_net/byte/errors'
+
+module SocialNet
+  module Byte
+    extend Config
+    include Errors
+    include Models
+  end
+end

data/lib/social_net/version.rb

@@ -1,3 +1,3 @@
 module SocialNet
-  VERSION = "0.2.19"
+  VERSION = "0.2.20"
 end

data/lib/social_net.rb

@@ -2,6 +2,7 @@ require "social_net/version"
 require "social_net/twitter"
 require "social_net/instagram"
 require "social_net/facebook"
+require "social_net/byte"
 
 module SocialNet
 end

data/spec/social_net/byte/post_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'social_net/byte'
+
+describe SocialNet::Byte::Post, :vcr do
+  before :all do
+    SocialNet::Byte.configure do |config|
+      if config.access_token.blank?
+        config.access_token = 'ACCESS_TOKEN'
+      end
+    end
+  end
+
+  let(:existing_post_id) { 'WZPPQ5LQJZAAHP4BWFLM6PRBNM' }
+  let(:nonexistant_post_id) { 'XAMM45LQJZNHHP4EWFLM6PMKIO' }
+
+  describe '.find_by id' do
+    subject(:post) { SocialNet::Byte::Post.find_by id: id }
+
+    context 'given an existing (case-sensitive) post id' do
+      let(:id) { existing_post_id }
+
+      it 'returns an object representing that post' do
+        expect(post.id).to eq 'WZPPQ5LQJZAAHP4BWFLM6PRBNM'
+        expect(post.comment_count).to be_an Integer
+      end
+    end
+
+    context 'given a non-existant post id' do
+      let(:id) { nonexistant_post_id }
+
+      it { expect(post).to be_nil }
+    end
+  end
+
+  describe '.find_by!' do
+    subject(:post) { SocialNet::Byte::Post.find_by! id: id }
+
+    context 'given an existing (case-sensitive) post id' do
+      let(:id) { existing_post_id }
+
+      it 'returns an object representing that post' do
+        expect(post.id).to eq 'WZPPQ5LQJZAAHP4BWFLM6PRBNM'
+        expect(post.comment_count).to be_an Integer
+      end
+    end
+
+    context 'given a non-existant post id' do
+      let(:id) { nonexistant_post_id }
+
+      it { expect{post}.to raise_error SocialNet::Byte::UnknownPost }
+    end
+  end
+end

data/spec/social_net/byte/user_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+require 'social_net/byte'
+
+describe SocialNet::Byte::User, :vcr do
+  before :all do
+    SocialNet::Byte.configure do |config|
+      if config.access_token.blank?
+        config.access_token = 'ACCESS_TOKEN'
+      end
+    end
+  end
+
+  let(:existing_username) { 'ollie' }
+  let(:unknown_username) { '01LjqweoojkjR' }
+  let(:existing_user_id_with_no_posts) { 'EGDL2NQ6WRFQRBSY6Q5D5HWKHQ' }
+  let(:existing_id) { 'PUEMKGYDBFAZ3HSRSAFGBAI5HA' }
+  let(:unknown_id) { '123456' }
+  let(:existing_cursor) { 'CXWZB7CTMYLTA' }
+
+  describe '.find_by username' do
+    subject(:user) { SocialNet::Byte::User.find_by username: username }
+
+    context 'given an existing (case-insensitive) username' do
+      let(:username) { existing_username }
+
+      it 'returns an object representing that user' do
+        expect(user.username).to eq 'ollie'
+        expect(user.follower_count).to be_an Integer
+      end
+    end
+
+    context 'given an unknown username' do
+      let(:username) { unknown_username }
+      it { expect(user).to be_nil }
+    end
+  end
+
+  describe '.find_by id' do
+    subject(:user) { SocialNet::Byte::User.find_by id: id }
+
+    context 'given an existing (case-sensitive) ID' do
+      let(:id) { existing_id }
+
+      it 'returns an object representing that user' do
+        expect(user.username).to eq 'ollie'
+        expect(user.follower_count).to be_an Integer
+      end
+    end
+
+    context 'given an unknown ID' do
+      let(:id) { unknown_id }
+      it { expect(user).to be_nil }
+    end
+  end
+
+  describe '.find_by!' do
+    subject(:user) { SocialNet::Byte::User.find_by! username: username }
+
+    context 'given an existing (case-sensitive) username' do
+      let(:username) { existing_username }
+
+      it 'returns an object representing that user' do
+        expect(user.username).to eq 'ollie'
+        expect(user.follower_count).to be_an Integer
+      end
+    end
+
+    context 'given an unknown username' do
+      let(:username) { unknown_username }
+      it { expect{user}.to raise_error SocialNet::Byte::UnknownUser }
+    end
+  end
+
+  describe '.posts' do
+    subject(:user) { SocialNet::Byte::User.find_by id: id }
+    context 'given an existing user with posts' do
+      let(:id) { existing_id }
+
+      it 'returns an array of video posts from the user' do
+        expect(user.posts[:posts]).to be_an Array
+        expect(user.posts[:posts].first).to be_an_instance_of SocialNet::Byte::Post
+      end
+    end
+
+    context 'given an existing user with no posts' do
+      let(:id) { existing_user_id_with_no_posts }
+
+      it 'returns an empty array from the user' do
+        expect(user.posts[:posts]).to be_an Array
+        expect(user.posts[:posts]).to be_empty
+      end
+    end
+
+    context 'given an existing user with paginated posts' do
+      let(:id) { existing_id }
+      let(:next_page) { existing_cursor }
+
+      it 'returns an array of video posts from the user' do
+        expect(user.posts({next_page: next_page})[:posts]).to be_an Array
+        expect(user.posts({next_page: next_page})[:posts].first).to be_an_instance_of SocialNet::Byte::Post
+        expect(user.posts({next_page: next_page})[:next_page]).not_to eq next_page
+      end
+    end
+  end
+end