scouter 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c1403462820c6babcda754965443992a7cfe199
-  data.tar.gz: 63f65229bbfa520666666741ec28553c0e415c4c
+  metadata.gz: de25a57191d53f274b602f1302d711dfe1984384
+  data.tar.gz: 4d037129761a3de61a5d30b0550c04313a19e330
 SHA512:
-  metadata.gz: fc65794f8c6425f4e478354620ab4d9e8f51d8b6b0a401a4ac9a29c3eaaa481429de4f4182d32c73f72f354f7ebd11d173c18ad21007a1ce468635c9ea4fdcc8
-  data.tar.gz: 823628cf9b067b4a2621e4c79f532569d82a976c785f3b3b571c0f0088a1054a7086d27939542626b9872e8addf8ccc06c2c7d12c1d98366314e6ff9cdef9c86
+  metadata.gz: ebec5f6833621e940f618c1efee5a1e13a2c486bb040480e1b8829d7b8cc25db14e945d55731f14a3d29296cafbd3452fdfe04633ea2168b6d9f2be7ff1ee177
+  data.tar.gz: b12926883efbce420c0527462229555029360393d515a0fb29ad66b95a7e8d59b66e4f5f7c27e52da68519847208098b80cdde28cc13d9ffd34b068ae89d02d6

data/README.md

@@ -26,7 +26,7 @@ Or install it yourself as:
 
 	require 'scouter'
 
-	results, errors = SocialCounter.new('http://google.com')
+	results, errors = Scouter.get_count('http://google.com')
 	results.each do |url, service|
 	  puts url #=> http://google.com
 	  puts service.buffer           #=> 129
@@ -40,7 +40,7 @@ Or install it yourself as:
 	
 if you want to get social count in facebook & twitter
 
-	results, errors = SocialCounter.new('http://google.com', [Scouter::Facebook, Scouter::Twitter])
+	results, errors = Scouter.get_count('http://google.com', [Scouter::Facebook, Scouter::Twitter])
 	results.each do |url, service|
 	  puts url #=> http://google.com
 	  puts service.facebook         #=> 166458
@@ -49,7 +49,7 @@ if you want to get social count in facebook & twitter
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/scouter/fork )
+1. Fork it ( https://github.com/morizyun/scouter/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/scouter/base/connection.rb

@@ -3,7 +3,7 @@ module Scouter
     module Connection
       # get response by url
       # @param [String] url url which returns json
-      # @return [Hash] json object
+      # @return [String] object by http request
       def get_response(url)
         open(url).read
       end

data/lib/scouter/base/object.rb

@@ -5,8 +5,9 @@ module Scouter
     class Object
       extend Scouter::Base::Connection
 
-      # get Count By URL
+      # Get Count By URL
       # @param [String or Array] urls
+      # @return [Hashie::Mash, Array] URL & count hash, Error
       def self.get_count(urls)
         urls = check_and_trans_url(urls)
         results, errors = {}, []
@@ -21,9 +22,9 @@ module Scouter
 
       private
 
-      # Get service name
-      # @return [String] urls URL list
-      # @return [String] service name
+      # Get response and parse it By URL
+      # @param [String or Array] urls
+      # @return [Hash, String] URL & count hash, Error message
       def self.get_and_parse_response(urls)
         url_str = api_url(urls)
         json    = get_response(url_str)
@@ -41,7 +42,8 @@ module Scouter
       end
 
       # Check and transform urls to Array
-      # @return [String] service name
+      # @param [String or Array] urls
+      # @return [Array] url
       def self.check_and_trans_url(url)
         url = to_array(url)
         raise ArgumentError, "#{url} is not String and Array" unless url.class == Array
@@ -63,14 +65,14 @@ module Scouter
       end
 
       # Parse response data for response (For Override)
-      # @param [Hashie::Mash] response
+      # @param [String] response
       # @return [Hash] urls & count
       def self.parse_response(response, url = nil)
       end
 
       # build API URL (For Override)
       # @param [String] url
-      # @return [String] API urls
+      # @return [String] API url
       def self.api_url(url)
       end
     end

data/lib/scouter/base/version.rb

@@ -1,3 +1,3 @@
 module Scouter
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/scouter/buffer.rb

@@ -2,8 +2,9 @@ module Scouter
   class Buffer < Scouter::Base::Object
     END_POINT = 'https://api.bufferapp.com/1'.freeze
 
-    # get Buffer Share Count
+    # Get Buffer Share Count
     # @param [String or Array] urls
+    # @return [Hashie::Mash, Array] URL & count hash, Error
     def self.get_count(urls)
       urls = check_and_trans_url(urls)
       results, errors = {}, []
@@ -19,9 +20,9 @@ module Scouter
 
     private
 
-    # Get and parse response data
-    # @return [String] urls URL list
-    # @return [String] service name
+    # Get and parse response data & error message
+    # @param [String] urls URL list
+    # @return [Hash, String] URL & count hash, Error message
     def self.get_and_parse_response(url)
       html  = get_response(api_url(url))
       res   = parse_response(html, url)
@@ -31,7 +32,7 @@ module Scouter
       return [nil, message]
     end
 
-    # build Feedly API URL
+    # Build Feedly API URL
     # @param [String] url
     # @return [String] API url
     def self.api_url(url)
@@ -39,7 +40,7 @@ module Scouter
     end
 
     # Parse json data for response
-    # @param [Hash] json
+    # @param [String] json
     # @return [Hash] url & count
     def self.parse_response(json, url)
       res = JSON.parse(json)

data/lib/scouter/facebook.rb

@@ -4,7 +4,7 @@ module Scouter
 
     private
 
-    # build Facebook Graph API url
+    # Build Facebook Graph API url
     # @param [Array] url
     # @return [String] API url
     def self.api_url(url)
@@ -12,13 +12,16 @@ module Scouter
       "#{END_POINT}/fql?q=SELECT%20url,%20total_count%20FROM%20link_stat%20WHERE%20url%20in%20(#{str})"
     end
 
-    # Parse json data of response
-    # @param [Hash] json
+    # Parse JSON data of response
+    # @param [String] json
     # @return [Hash] url & count
     def self.parse_response(json, urls = nil)
       parse_response_item(JSON.parse(json)['data'])
     end
 
+    # Parse JSON List data of response
+    # @param [Array] json_list
+    # @return [Hash] url & count
     def self.parse_response_item(json_list)
       results = {}
       json_list.each do |json|

data/lib/scouter/feedly.rb

@@ -2,8 +2,9 @@ module Scouter
   class Feedly < Scouter::Base::Object
     END_POINT = 'http://cloud.feedly.com/v3'.freeze
 
-    # get Feedly Count
+    # Get feedly Count
     # @param [String or Array] urls
+    # @return [Hashie::Mash, Array] URL & count hash, Error
     def self.get_count(urls)
       urls = check_and_trans_url(urls)
       results, errors = {}, []
@@ -19,7 +20,7 @@ module Scouter
 
     private
 
-    # build Feedly API URL
+    # Build Feedly API URL
     # @param [String] url
     # @return [String] API url
     def self.api_url(url)
@@ -28,7 +29,8 @@ module Scouter
     end
 
     # Parse json data for response
-    # @param [Hash] json
+    # @param [String] json response by API
+    # @param [String] url url
     # @return [Hash] url & count
     def self.parse_response(json, url)
       res = JSON.parse(json)

data/lib/scouter/google_plus.rb

@@ -2,8 +2,9 @@ module Scouter
   class GooglePlus < Scouter::Base::Object
     API_KEY = 'AIzaSyCKSbrvQasunBoV16zDH9R33D88CeLr9gQ'.freeze
 
-    # get Google Plus Count
+    # Get Google+ Count
     # @param [String or Array] urls
+    # @return [Hashie::Mash, Array] URL & count hash, Error
     def self.get_count(urls)
       urls = check_and_trans_url(urls)
       results, errors = {}, []
@@ -20,8 +21,8 @@ module Scouter
     private
 
     # Get and parse response
-    # @return [String] urls URL list
-    # @return [String] service name
+    # @param [String] url
+    # @return [Hash, String] URL & count hash, Error message
     def self.get_and_parse_response(url)
       json  = get_response(url)
       res   = parse_response(json, url)
@@ -31,9 +32,9 @@ module Scouter
       return [nil, message]
     end
 
-    # get json data from API
+    # Get json data from API
     # @param [String] url
-    # @return [Hash] response from API
+    # @return [String] response from API
     def self.get_response(url)
       option = {'Content-Type' => 'application/json'}
       request = Net::HTTP::Post.new(api_uri.request_uri, option)
@@ -57,15 +58,15 @@ module Scouter
       }.body
     end
 
-    # Build url for api
-    # @param [Hash] json
-    # @return [String] API url
+    # Build url for API
+    # @return [URI] URI object of API URL
     def self.api_uri
       URI.parse("https://clients6.google.com/rpc?key=#{API_KEY}")
     end
 
-    # Parse json data of response
-    # @param [Hash] response
+    # Parse Json data of response
+    # @param [Array] json_list
+    # @param [String] url
     # @return [Hash] url & count
     def self.parse_response(json_list, url)
       results = {}

data/lib/scouter/hatena_bookmark.rb

@@ -4,7 +4,7 @@ module Scouter
 
     private
 
-    # build Hatena Bookmark Count API URL
+    # Build Hatena Bookmark Count API URL
     # @param [Array] url
     # @return [String] API url
     def self.api_url(url)
@@ -12,13 +12,16 @@ module Scouter
       "#{END_POINT}/entry.counts?#{url_str}"
     end
 
-    # Parse json data of response
-    # @param [Hash] response
+    # Parse JSON data of response
+    # @param [String] response
     # @return [Hash] url & count
     def self.parse_response(response, urls = nil)
       parse_response_item(JSON.parse(response))
     end
 
+    # Parse JSON list data of response
+    # @param [Array] response
+    # @return [Hash] url & count
     def self.parse_response_item(json_list)
       results = {}
       json_list.each do |json|

data/lib/scouter/linkedin.rb

@@ -2,8 +2,9 @@ module Scouter
   class Linkedin < Scouter::Base::Object
     END_POINT = 'https://www.linkedin.com/countserv'.freeze
 
-    # get Linkedin Count
+    # Get Linkedin Count
     # @param [String or Array] urls
+    # @return [Hashie::Mash, Array] URL & count hash, Error
     def self.get_count(urls)
       urls = check_and_trans_url(urls)
       results, errors = {}, []
@@ -19,19 +20,20 @@ module Scouter
 
     private
 
-    # Build url for api
-    # @param [Hash] json
+    # Build url for API
+    # @param [String] url
     # @return [String] API url
     def self.api_url(url)
       "#{END_POINT}/count/share?url=#{url}&format=json"
     end
 
-    # Parse json data for response
-    # @param [Hash] json
+    # Parse JSON data for response
+    # @param [String] json
+    # @param [String] url
     # @return [Hash] url & count
     def self.parse_response(json, url)
       res = JSON.parse(json)
-      { res['url'] => { self.service_name => res['count'] } }
+      { url => { self.service_name => res['count'] } }
     end
   end
 end

data/lib/scouter/pinterest.rb

@@ -2,8 +2,9 @@ module Scouter
   class Pinterest < Scouter::Base::Object
     END_POINT = 'http://api.pinterest.com/v1'.freeze
 
-    # get Pinterest Count
+    # Get Pinterest Count
     # @param [String or Array] urls
+    # @return [Hashie::Mash, Array] URL & count hash, Error
     def self.get_count(urls)
       urls = check_and_trans_url(urls)
       results, errors = {}, []
@@ -19,15 +20,16 @@ module Scouter
 
     private
 
-    # Build url for api
-    # @param [Hash] json
+    # Build url for API
+    # @param [String] url
     # @return [String] API url
     def self.api_url(url)
       "#{END_POINT}/urls/count.json?url=#{url}"
     end
 
-    # Parse json data for response
-    # @param [Hash] json
+    # Parse JSON data for response
+    # @param [String] json
+    # @param [String] url
     # @return [Hash] url & count
     def self.parse_response(json, url)
       res = JSON.parse(json.gsub(/(receiveCount\(|\))/, ''))

data/lib/scouter/pocket.rb

@@ -2,8 +2,9 @@ module Scouter
   class Pocket < Scouter::Base::Object
     END_POINT = 'https://widgets.getpocket.com'.freeze
 
-    # get Pocket Count
+    # Get Pocket Count
     # @param [String or Array] urls
+    # @return [Hashie::Mash, Array] URL & count hash, Error
     def self.get_count(urls)
       urls = check_and_trans_url(urls)
       results, errors = {}, []
@@ -17,6 +18,8 @@ module Scouter
       return [res_hash, errors]
     end
 
+    # Set API parameter for test mock
+    # @param [String or Array] num
     def self.set_api_random(num)
       @@api_rand_num = num
     end
@@ -24,8 +27,8 @@ module Scouter
     private
 
     # Get and parse response data
-    # @return [String] urls URL list
-    # @return [String] service name
+    # @param [String] url URL
+    # @return [Hash, String] URL & count hash, Error message
     def self.get_and_parse_response(url)
       html  = get_response(api_url(url))
       res   = parse_response(html, url)
@@ -35,7 +38,7 @@ module Scouter
       return [nil, message]
     end
 
-    # build Pocket API URL
+    # Build Pocket API URL
     # @param [String] url
     # @return [String] API url
     def self.api_url(url)
@@ -45,7 +48,8 @@ module Scouter
     end
 
     # Parse html for response
-    # @param [Hash] html
+    # @param [String] html
+    # @param [String] url
     # @return [Hash] url & count
     def self.parse_response(html, url)
       count = (html.to_s =~ /id="cnt"[^0-9]+([0-9]+)/) ? $1.to_i : 0

data/lib/scouter/twitter.rb

@@ -2,8 +2,9 @@ module Scouter
   class Twitter < Scouter::Base::Object
     END_POINT = 'http://urls.api.twitter.com'.freeze
 
-    # get Twitter Count
+    # Get Twitter Count
     # @param [String or Array] urls
+    # @return [Hashie::Mash, Array] URL & count hash, Error
     def self.get_count(urls)
       urls = check_and_trans_url(urls)
       results, errors = {}, []
@@ -19,7 +20,7 @@ module Scouter
 
     private
 
-    # build Twitter API URL
+    # Build Twitter API URL
     # @param [String] url
     # @return [String] API url
     def self.api_url(url)
@@ -27,8 +28,9 @@ module Scouter
       "#{END_POINT}/1/urls/count.json?url=#{escaped_url}"
     end
 
-    # Parse json data for response
-    # @param [Hash] json
+    # Parse JSON data for response
+    # @param [String] json data
+    # @param [String] url
     # @return [Hash] url & count
     def self.parse_response(json, url)
       res = JSON.parse(json)

data/lib/scouter.rb

@@ -33,10 +33,12 @@ module Scouter
                Scouter::Pocket,
                Scouter::Twitter ]
 
-  # get Social Count By Buffer/Facebook/Feedly/GooglePlus/HatenaBookmark/Linkedin/Pinterest/Pocket/Twitter
-  # @param [String or Array] urls
+  # Get Social Count By Buffer/Facebook/Feedly/GooglePlus/HatenaBookmark/Linkedin/Pinterest/Pocket/Twitter
+  # @param [String or Array] urls url list ot get count
+  # @param [Array or nil] service service list to get count
+  # @return [Hashie::Mash, Hashie::Mash] URL & count hash, Error
   def self.get_count(urls, services = SERVICES)
-    results, errors = [], {}
+    results, errors = [], Hashie::Mash.new()
 
     Parallel.each(services, in_threads: services.count) do |service|
       result, error = service.get_count(urls)
@@ -50,6 +52,9 @@ module Scouter
 
   private
 
+  # Merge result data of service to hash
+  # @param [Hashie::Mash] social count & url of some services
+  # @return [Hashie::Mash] URL & count hash, Error
   def self.results_merged_hash(results)
     results_hash = {}
     results.each do |item|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scouter
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - morizyun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-16 00:00:00.000000000 Z
+date: 2014-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie