Setup rubocop and og (#124)

* drop ruby < 2.5
* setup rubocop for linting and fix issues automatically
* add og scraper

Author: ferhatelmas

.rubocop.yml

@@ -0,0 +1,45 @@
+AllCops:
+  DisabledByDefault: false
+  NewCops: enable
+  TargetRubyVersion: 2.5
+
+Layout/LineLength:
+  Enabled: false
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: false
+Lint/RedundantCopDisableDirective:
+  Enabled: false
+Lint/RedundantSafeNavigation:
+  Enabled: false
+
+
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Security/Open:
+  Enabled: false
+
+Style/AccessorGrouping:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/DoubleCopDisableDirective:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false

.travis.yml

@@ -2,8 +2,9 @@ language: ruby
 before_install:
   - gem update bundler
 rvm:
-  - 2.2
-  - 2.3
-  - 2.4
   - 2.5
   - 2.6
+  - 2.7
+script:
+  - bundle exec rake rubocop
+  - bundle exec rake test

Gemfile

@@ -1,10 +1,13 @@
-source "https://rubygems.org/"
+source 'https://rubygems.org/'
 
 gemspec
 
+group :dev do
+  gem 'rubocop', require: false
+end
+
 group :test do
-  gem "faraday"
-  gem "rack"
-  gem "simplecov"
-  gem "yard"
+  gem 'faraday'
+  gem 'rack'
+  gem 'yard'
 end

README.md

@@ -10,13 +10,7 @@ You can sign up for a Stream account at https://getstream.io/get_started.
 
 #### Ruby version requirements and support
 
-This API Client project requires Ruby 2.2.10 at a minimum. We will support the following versions:
-
-- 2.2.10
-- 2.3.8
-- 2.4.5
-- 2.5.5
-- 2.6.2
+This API Client project requires Ruby 2.5.x at a minimum.
 
 See the [Travis configuration](.travis.yml) for details of how it is built and tested.
 
@@ -81,7 +75,7 @@ client.update_activities([activity_data])
 user_feed_1.remove_activity('e561de8f-00f1-11e4-b400-0cc47a024be0')
 
 # Remove activities by their foreign_id
-user_feed_1.remove_activity('tweet:1', foreign_id = true)
+user_feed_1.remove_activity('tweet:1', foreign_id: true)
 
 # Follow another feed
 user_feed_1.follow('flat', '42')
@@ -152,6 +146,9 @@ activity = {
   actor: 'User:2', verb: 'pin', object: 'Place:42', target: 'Board:1'
 }
 client.add_to_many(activity, feeds)
+
+# Retrive open graph information
+client.og('https://google.com')
 ```
 
 ### Copyright and License Information

Rakefile

@@ -1,7 +1,12 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new
 
-task :default => [:spec]
-task :test => [:spec]
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--display-cop-names']
+end
+
+task default: [:spec]
+task test: [:spec]

lib/stream/activities.rb

@@ -1,6 +1,5 @@
 module Stream
   module Activities
-
     #
     # Get activities directly, via ID or Foreign ID + timestamp
     #
@@ -28,13 +27,13 @@ def get_activities(params = {})
       if params[:foreign_id_times]
         foreign_ids = []
         timestamps = []
-        params[:foreign_id_times].each{|e|
+        params[:foreign_id_times].each do |e|
           foreign_ids << e[:foreign_id]
           timestamps << e[:time]
-        }
+        end
         params = {
           foreign_ids: foreign_ids,
-          timestamps: timestamps,
+          timestamps: timestamps
         }
       end
       signature = Stream::Signer.create_jwt_token('activities', '*', @api_secret, '*')
@@ -142,8 +141,8 @@ def activity_partial_update(data = {})
     #   ])
     #
     def batch_activity_partial_update(changes = [])
-        signature = Stream::Signer.create_jwt_token('activities', '*', @api_secret, '*')
-        make_request(:post, '/activity/', signature, {}, {:changes => changes})
+      signature = Stream::Signer.create_jwt_token('activities', '*', @api_secret, '*')
+      make_request(:post, '/activity/', signature, {}, { changes: changes })
     end
   end
 end

lib/stream/batch.rb

@@ -16,9 +16,7 @@ module Batch
     #
     def follow_many(follows, activity_copy_limit = nil)
       query_params = {}
-      unless activity_copy_limit.nil?
-        query_params['activity_copy_limit'] = activity_copy_limit
-      end
+      query_params['activity_copy_limit'] = activity_copy_limit unless activity_copy_limit.nil?
       signature = Stream::Signer.create_jwt_token('follower', '*', @api_secret, '*')
       make_request(:post, '/follow_many/', signature, query_params, follows)
     end
@@ -52,8 +50,8 @@ def unfollow_many(unfollows)
     #
     def add_to_many(activity_data, feeds)
       data = {
-        :feeds => feeds,
-        :activity => activity_data
+        feeds: feeds,
+        activity: activity_data
       }
       signature = Stream::Signer.create_jwt_token('feed', '*', @api_secret, '*')
       make_request(:post, '/feed/add_to_many/', signature, {}, data)

lib/stream/client.rb

@@ -5,8 +5,8 @@
 require 'stream/url'
 
 module Stream
-  STREAM_URL_COM_RE = %r{https\:\/\/(?<key>\w+)\:(?<secret>\w+)@((api\.)|((?<location>[-\w]+)\.))?(?<api_hostname>stream-io-api\.com)\/[\w=-\?%&]+app_id=(?<app_id>\d+)}i
-  STREAM_URL_IO_RE = %r{https\:\/\/(?<key>\w+)\:(?<secret>\w+)@((api\.)|((?<location>[-\w]+)\.))?(?<api_hostname>getstream\.io)\/[\w=-\?%&]+app_id=(?<app_id>\d+)}i
+  STREAM_URL_COM_RE = %r{https://(?<key>\w+):(?<secret>\w+)@((api\.)|((?<location>[-\w]+)\.))?(?<api_hostname>stream-io-api\.com)/[\w=-?%&]+app_id=(?<app_id>\d+)}i.freeze
+  STREAM_URL_IO_RE = %r{https://(?<key>\w+):(?<secret>\w+)@((api\.)|((?<location>[-\w]+)\.))?(?<api_hostname>getstream\.io)/[\w=-?%&]+app_id=(?<app_id>\d+)}i.freeze
 
   class Client
     attr_reader :api_key
@@ -36,7 +36,6 @@ class Client
     #   Stream::Client.new('my_key', 'my_secret', 'my_app_id', :location => 'us-east')
     #
     def initialize(api_key = '', api_secret = '', app_id = nil, opts = {})
-
       if api_key.nil? || api_key.empty?
         env_url = ENV['STREAM_URL']
         if env_url =~ Stream::STREAM_URL_COM_RE
@@ -100,7 +99,7 @@ def create_user_session_token(user_id, extra_data = {})
     # @return [string]
     #
     def create_user_token(user_id, extra_data = {})
-      return Stream::Signer.create_user_token(user_id, extra_data, api_secret)
+      Stream::Signer.create_user_token(user_id, extra_data, api_secret)
     end
 
     def personalization
@@ -128,16 +127,21 @@ def update_activities(activities)
       make_request(:post, '/activities/', auth_token, {}, 'activities' => activities)
     end
 
+    def og(uri)
+      auth_token = Stream::Signer.create_jwt_token('*', '*', @api_secret, '*')
+      make_request(:get, '/og', auth_token, { url: uri })
+    end
+
     def get_default_params
-      {:api_key => @api_key}
+      { api_key: @api_key }
     end
 
     def get_http_client
-      @http_client ||= StreamHTTPClient.new(url_generator)
+      @get_http_client ||= StreamHTTPClient.new(url_generator)
     end
 
     def make_query_params(params)
-      Hash[get_default_params.merge(params).sort_by {|k, v| k.to_s}]
+      Hash[get_default_params.merge(params).sort_by { |k, _v| k.to_s }]
     end
 
     def make_request(method, relative_url, signature, params = {}, data = {}, headers = {})
@@ -187,7 +191,7 @@ def make_http_request(method, relative_url, params = nil, data = nil, headers =
 
       case response[:status].to_i
       when 200..203
-        return ::JSON.parse(response[:body])
+        ::JSON.parse(response[:body])
       end
     end
   end
@@ -196,16 +200,16 @@ class RaiseHttpException < Faraday::Middleware
     def call(env)
       @app.call(env).on_complete do |response|
         case response[:status].to_i
-          when 200..203
-            return response
-          when 401
-            raise StreamApiResponseException, error_message(response, 'Bad feed')
-          when 403
-            raise StreamApiResponseException, error_message(response, 'Bad auth/headers')
-          when 404
-            raise StreamApiResponseException, error_message(response, 'url not found')
-          when 204...600
-            raise StreamApiResponseException, error_message(response, _build_error_message(response.body))
+        when 200..203
+          return response
+        when 401
+          raise StreamApiResponseException, error_message(response, 'Bad feed')
+        when 403
+          raise StreamApiResponseException, error_message(response, 'Bad auth/headers')
+        when 404
+          raise StreamApiResponseException, error_message(response, 'url not found')
+        when 204...600
+          raise StreamApiResponseException, error_message(response, _build_error_message(response.body))
         end
       end
     end
@@ -229,7 +233,7 @@ def _build_error_message(response)
     end
 
     def error_message(response, body = nil)
-      "#{response[:method].to_s.upcase} #{response[:url]}: #{[response[:status].to_s + ':', body].compact.join(' ')}"
+      "#{response[:method].to_s.upcase} #{response[:url]}: #{["#{response[:status]}:", body].compact.join(' ')}"
     end
   end
 end

lib/stream/collections.rb

@@ -4,28 +4,28 @@ def add(collection_name, collection_data, id: nil, user_id: nil)
       data = {
         id: id,
         user_id: user_id,
-        data: collection_data,
+        data: collection_data
       }
       uri = "/collections/#{collection_name}/"
-      make_collection_request(:post, {}, data, :endpoint => uri)
+      make_collection_request(:post, {}, data, endpoint: uri)
     end
 
     def get(collection_name, id)
       uri = "collections/#{collection_name}/#{id}/"
-      make_collection_request(:get, {}, {}, :endpoint => uri)
+      make_collection_request(:get, {}, {}, endpoint: uri)
     end
 
     def update(collection_name, id, data: nil)
       data = {
         data: data
       }
       uri = "collections/#{collection_name}/#{id}/"
-      make_collection_request(:put, {}, data, :endpoint => uri)
+      make_collection_request(:put, {}, data, endpoint: uri)
     end
 
     def delete(collection_name, id)
       uri = "collections/#{collection_name}/#{id}/"
-      make_collection_request(:delete, {}, {}, :endpoint => uri)
+      make_collection_request(:delete, {}, {}, endpoint: uri)
     end
 
     def upsert(collection, objects = [])
@@ -53,11 +53,9 @@ def delete_many(collection, ids = [])
     end
 
     def create_reference(collection, id)
-      _id = id
-      if id.respond_to?(:keys) and !id["id"].nil?
-        _id = id["id"]
-      end
-      "SO:#{collection}:#{_id}"
+      k = id
+      k = id['id'] if id.respond_to?(:keys) && !id['id'].nil?
+      "SO:#{collection}:#{k}"
     end
 
     private