social_shares 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9eab70ae26105c23d80e83cd6a724440fe9a47d
-  data.tar.gz: 96f8dcb9dbcbc5c4ce1705df0fdc3eb1b9a4f77d
+  metadata.gz: 3642b7fd39221e877acaa31168a1cf7e87f9868b
+  data.tar.gz: fb6d78c291949dbff0fc77c9ee2536e8914ce6bf
 SHA512:
-  metadata.gz: 235d154c6b9fc6718e718451fea185d49d5d49fb4a4f04c8bac506936055eceb3c7179a18286054982b779144434bfeff4e05a7a5a705e31e4be2a8134e9f99a
-  data.tar.gz: 7cedea104f5bfe46e8be93c7a81a5060befeacb225b276aa416e67a512a44e90a22fe026ace435170714bc249c4774b1610af668b170d5db12dcd1d8de1ab685
+  metadata.gz: d5c6d41eda0fe528a92a42c972fedde5b88235dcf9e0f767c88a499f964d2e3c554a1295a94bebd5aa8a85cf3a4a5732c38ca6eeb38f317126f386d8ce26d917
+  data.tar.gz: 20ac77025ed29fee54a1368d05f3c6f8ac35290c9f3e8ca379b929cb34fd69d768615c68538487ababd6adcc24e2ba820a841bfc8e16b8a69e1837d57c298845

data/README.md

@@ -23,7 +23,6 @@ Russian:
 * [vkontakte](http://vkontakte.ru/)
 * [mail.ru(aka moi mir)](http://my.mail.ru/)
 * [odnoklassniki](http://www.odnoklassniki.ru/)
-* [yandex](http://yandex.ru/) (currently on beta, most of time returns 0)
 
 Chinese:
 * [weibo](http://www.weibo.com)
@@ -67,7 +66,7 @@ Fetch all shares by one method (#all, #all!):
 ```ruby
 # in case of exception it will return nil
 :000 > SocialShares.all url
- => {:vkontakte=>nil, :facebook=>399027, :google=>28346, :twitter=>1836, :mail_ru=>37, :odnoklassniki=>1, :reddit=>2361, :linkedin=>33, :pinterest=>21011, :stumbleupon=>43035, :weibo=>12760, :buffer=>1662, :yandex=>0}
+ => {:vkontakte=>nil, :facebook=>399027, :google=>28346, :twitter=>1836, :mail_ru=>37, :odnoklassniki=>1, :reddit=>2361, :linkedin=>33, :pinterest=>21011, :stumbleupon=>43035, :weibo=>12760, :buffer=>1662}
 
 # and this will raise it
 :000 > SocialShares.all! url
@@ -112,7 +111,33 @@ Does any network have at least one link?
 ```
 Note that #has_any? is faster than (#total > 0), because it stops on first network that has at least 1 sharing
 
-Instalation
+Configuring
+-----
+You can specify timeout and open_timeout for each social network
+```ruby
+SocialShares.config = {
+  twitter: {timeout: 4, open_timeout: 7},
+  facebook: {timeout: 10, open_timeout: 15}
+}
+```
+
+- `:open_timeout` is the timeout for opening the connection. This is useful if you are calling servers with slow or shaky response times. Default value is 3 seconds.
+- `:timeout` is the timeout for reading the answer. This is useful to make sure you will not get stuck half way in the reading process, or get stuck reading a 5 MB file when you're expecting 5 KB of JSON. Default value is 3 seconds.
+
+If you use Rails, you can create file `config/initializers/social_shares.rb` and fill it with this config.
+
+Try it by yourself before installation
+-----
+Send request through shell to test numbers. Please do NOT use this url in your projects.
+```bash
+curl -X POST -d '{"url": "http://www.apple.com", "networks": ["facebook", "google", "reddit"]}' https://social-shares-api-cedar-14.herokuapp.com/
+```
+You will see:
+```bash
+{"facebook":312412,"google":46088,"reddit":114}
+```
+
+Installation
 -----
 Include the gem in your Gemfile:
 ```

data/lib/social_shares.rb

@@ -1,5 +1,6 @@
 require 'rest-client'
 require 'json'
+require 'social_shares/string_helper'
 require 'social_shares/version'
 require 'social_shares/base'
 require 'social_shares/facebook'
@@ -14,15 +15,20 @@ require 'social_shares/pinterest'
 require 'social_shares/stumbleupon'
 require 'social_shares/weibo'
 require 'social_shares/buffer'
-require 'social_shares/yandex'
 
 module SocialShares
   class << self
+    include SocialShares::StringHelper
+
+    def config=(val)
+      SocialShares::Base.config = val
+    end
+
     SUPPORTED_NETWORKS = [
       :vkontakte,
       :facebook,
       :google,
-      :twitter,
+      # :twitter,
       :mail_ru,
       :odnoklassniki,
       :reddit,
@@ -31,7 +37,6 @@ module SocialShares
       :stumbleupon,
       :weibo,
       :buffer,
-      :yandex,
     ]
 
     def supported_networks
@@ -40,12 +45,12 @@ module SocialShares
 
     SUPPORTED_NETWORKS.each do |network_name|
       define_method(network_name) do |url|
-        class_name = network_name.to_s.split('_').map(&:capitalize).join
+        class_name = to_camel_case(network_name.to_s)
         SocialShares.const_get(class_name).new(url).shares
       end
 
       define_method("#{network_name}!") do |url|
-        class_name = network_name.to_s.split('_').map(&:capitalize).join
+        class_name = to_camel_case(network_name.to_s)
         SocialShares.const_get(class_name).new(url).shares!
       end
     end

data/lib/social_shares/base.rb

@@ -1,6 +1,17 @@
 module SocialShares
   class Base
-    TIMEOUT = OPEN_TIMEOUT = 3
+    include SocialShares::StringHelper
+    DEFAULT_TIMEOUT = 3
+    DEFAULT_OPEN_TIMEOUT = 3
+
+    @@config = {}
+
+    class << self
+      def config=(val)
+        @@config = val
+      end
+    end
+
     attr_accessor :checked_url
 
     def initialize(checked_url)
@@ -21,12 +32,24 @@ module SocialShares
 
   protected
 
+    def config_name
+      to_underscore(self.class.name.split('::').last).to_sym
+    end
+
+    def timeout
+      (@@config[config_name] || {})[:timeout] || DEFAULT_TIMEOUT
+    end
+
+    def open_timeout
+      (@@config[config_name] || {})[:open_timeout] || DEFAULT_OPEN_TIMEOUT
+    end
+
     def get(url, params)
-      RestClient::Resource.new(url, timeout: TIMEOUT, open_timeout: OPEN_TIMEOUT).get(params)
+      RestClient::Resource.new(url, timeout: timeout, open_timeout: open_timeout).get(params)
     end
 
     def post(url, params, headers = {})
-      RestClient::Resource.new(url, timeout: TIMEOUT, open_timeout: OPEN_TIMEOUT).post(params, headers)
+      RestClient::Resource.new(url, timeout: timeout, open_timeout: open_timeout).post(params, headers)
     end
   end
 end

data/lib/social_shares/buffer.rb

@@ -3,7 +3,8 @@ module SocialShares
     URL = 'https://api.bufferapp.com/1/links/shares.json'
 
     def shares!
-      response = get(URL, {:params => {:url => checked_url}})
+      response = get(URL, params: { url: checked_url })
+
       JSON.parse(response)['shares']
     end
   end

data/lib/social_shares/facebook.rb

@@ -4,10 +4,11 @@ module SocialShares
 
     def shares!
       response = get(URL, {
-        :params => {
-          :q => "SELECT share_count FROM link_stat WHERE url='#{checked_url}'"
+        params: {
+          q: "SELECT share_count FROM link_stat WHERE url='#{checked_url}'"
         }
       })
+
       JSON.parse(response)['data'][0]['share_count'] || 0
     end
   end

data/lib/social_shares/google.rb

@@ -3,7 +3,8 @@ module SocialShares
     URL = 'https://clients6.google.com/rpc?key=AIzaSyCKSbrvQasunBoV16zDH9R33D88CeLr9gQ'
 
     def shares!
-      response = post(URL, JSON.dump(params), {content_type: :json, accept: :json})
+      response = post(URL, JSON.dump(params), { content_type: :json, accept: :json })
+
       JSON.parse(response)[0]['result']['metadata']['globalCounts']['count'].to_i
     end
 

data/lib/social_shares/linkedin.rb

@@ -4,11 +4,12 @@ module SocialShares
 
     def shares!
       response = get(URL, {
-                    :params => {
-                      :url => checked_url,
-                      :format => 'json'
-                    }
-                  })
+        params: {
+          url: checked_url,
+          format: 'json'
+        }
+      })
+
       JSON.parse(response)['count']
     end
   end

data/lib/social_shares/mail_ru.rb

@@ -10,6 +10,7 @@ module SocialShares
           url_list: checked_url
         }
       })
+
       matches = /shares":(\d+)/.match(response)
       matches ? matches[-1].to_i : 0
     end

data/lib/social_shares/odnoklassniki.rb

@@ -10,6 +10,7 @@ module SocialShares
           ref: checked_url
         }
       })
+
       /'(\d+)'\)/.match(response)[-1].to_i
     end
   end

data/lib/social_shares/pinterest.rb

@@ -3,7 +3,8 @@ module SocialShares
     URL = 'http://api.pinterest.com/v1/urls/count.json'
 
     def shares!
-      response = get(URL, {:params => {:url => checked_url}})
+      response = get(URL, params: { url: checked_url })
+
       /count":(\d+)/.match(response)[-1].to_i
     end
   end

data/lib/social_shares/reddit.rb

@@ -3,9 +3,10 @@ module SocialShares
     URL = 'http://www.reddit.com/api/info.json'
 
     def shares!
-      response = get(URL, {:params => {:url => checked_url}})
+      response = get(URL, params: { url: checked_url })
+
       children_data = JSON.parse(response)['data']['children']
-      children_data.map{|c| c['data']['score']}.reduce(:+) || 0
+      children_data.map { |c| c['data']['score'] }.reduce(:+) || 0
     end
   end
 end

data/lib/social_shares/string_helper.rb

@@ -0,0 +1,11 @@
+module SocialShares
+  module StringHelper
+    def to_underscore(str)
+      str.dup.tap { |s| (s.gsub!(/(.)([A-Z])/,'\1_\2') || s).downcase! }
+    end
+
+    def to_camel_case(str)
+      str.split('_').map(&:capitalize).join
+    end
+  end
+end

data/lib/social_shares/stumbleupon.rb

@@ -3,7 +3,8 @@ module SocialShares
     URL = 'http://www.stumbleupon.com/services/1.01/badge.getinfo'
 
     def shares!
-      response = get(URL, {:params => {:url => checked_url}})
+      response = get(URL, params: { url: checked_url })
+
       JSON.parse(response)['result']['views'] || 0
     end
   end

data/lib/social_shares/twitter.rb

@@ -3,7 +3,8 @@ module SocialShares
     URL = 'http://cdn.api.twitter.com/1/urls/count.json'
 
     def shares!
-      response = get(URL, {:params => {:url => checked_url}})
+      response = get(URL, params: { url: checked_url })
+
       JSON.parse(response)['count']
     end
   end

data/lib/social_shares/version.rb

@@ -1,3 +1,3 @@
 module SocialShares
-  VERSION = '0.2.7'
+  VERSION = '0.3.0'
 end

data/lib/social_shares/vkontakte.rb

@@ -4,12 +4,13 @@ module SocialShares
 
     def shares!
       response = get(URL, {
-                    :params => {
-                      :act => 'count',
-                      :index => 1,
-                      :url => checked_url,
-                    }
-                  })
+        params: {
+          act: 'count',
+          index: 1,
+          url: checked_url
+        }
+      })
+
       /VK.Share.count\(1,\s(\d+)\)/.match(response)[1].to_i
     end
   end

data/lib/social_shares/weibo.rb

@@ -5,12 +5,13 @@ module SocialShares
 
     def shares!
       response = get(URL_FOR_SHARE, {
-                    :params => {
-                      :_ => '1414437609900',
-                      :source => '8003029170',
-                      :url_short => short_url
-                    }
-                  })
+        params: {
+          _: '1414437609900',
+          source: '8003029170',
+          url_short: short_url
+        }
+      })
+
       JSON.parse(response)['urls'].first['share_counts'].to_i
     end
 

data/lib/social_shares/yandex.rb

@@ -3,7 +3,8 @@ module SocialShares
     URL = 'http://wow.ya.ru/ajax/share-counter.xml'
 
     def shares!
-      response = RestClient.get(URL, {params: {url: checked_url}})
+      response = RestClient.get(URL, params: { url: checked_url })
+
       /(\d+)/.match(response)[-1].to_i
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: social_shares
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Timur Kozmenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-04 00:00:00.000000000 Z
+date: 2016-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -102,6 +102,7 @@ files:
 - lib/social_shares/odnoklassniki.rb
 - lib/social_shares/pinterest.rb
 - lib/social_shares/reddit.rb
+- lib/social_shares/string_helper.rb
 - lib/social_shares/stumbleupon.rb
 - lib/social_shares/twitter.rb
 - lib/social_shares/version.rb