shared_count_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c296f7db9d808d5a5ca56f2e65ef1c3c982a020a
+  data.tar.gz: 13a35672bdee8df4aad645357ebe1e2494ab41a1
+SHA512:
+  metadata.gz: 8e400c6453447b54f0653887acd6c5bce1eaeb7f8f4d85f8266fb90f7fc05b97b477e7ad75a89dc400ebf835eee22e0df3c93e74bdca6484d509dedba7a97f72
+  data.tar.gz: 367c36c0cfe875c0c18cb68f09cd7067ed2a45bad3acbb26f15d0df539fa5e07b63775c5daad1736498acaf4ecc74dbad0ddc99fda30d908d8b6e9ac8c98be93

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rbenv-gemsets

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p353

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shared_count_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Cristian Rasch
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# SharedCountApi
+
+Thin wrapper around the SharedCount API in vanilla Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shared_count_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shared_count_api
+
+## Usage
+
+```ruby
+require "shared_count_api"
+client = SharedCountApi::Client.new("http://slashdot.org")
+client.twitter # => 24381
+client.facebook_share_count # => 2705
+client.google_plus_one # => 16633
+# you get the drill ;)
+```
+
+## Contributing
+
+1. Fork it
+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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+  t.verbose = true
+end
+
+task default: :test

data/lib/shared_count_api/version.rb

@@ -0,0 +1,3 @@
+module SharedCountApi
+  VERSION = "0.0.1"
+end

data/lib/shared_count_api.rb

@@ -0,0 +1,95 @@
+require_relative "shared_count_api/version"
+require "net/http"
+require "json"
+require "ostruct"
+
+module SharedCountApi
+  class Error < StandardError
+    attr_reader :type, :error
+
+    def initialize(type, message)
+      @type, @message = type, message
+    end
+  end
+
+  INVALID_URL = Error.new("invalid_url", "Not a valid URL.")
+
+  class Client
+    HTTP_ENDPOINT = "http://api.sharedcount.com/".freeze
+    HTTPS_ENDPOINT = "https://sharedcount.appspot.com/".freeze
+
+    def initialize(url, use_ssl = false)
+      @url, @use_ssl = url, use_ssl
+    end
+
+    def stumble_upon
+      response["StumbleUpon"]
+    end
+
+    def reddit
+      response["Reddit"]
+    end
+
+    def facebook_like_count
+      facebook_metrics["like_count"]
+    end
+
+    def facebook_share_count
+      facebook_metrics["share_count"]
+    end
+
+    def delicious
+      response["Delicious"]
+    end
+
+    def google_plus_one
+      response["GooglePlusOne"]
+    end
+
+    def buzz
+      response["Buzz"]
+    end
+
+    def twitter
+      response["Twitter"]
+    end
+
+    def diggs
+      response["Diggs"]
+    end
+
+    def pinterest
+      response["Pinterest"]
+    end
+
+    def linked_in
+      response["LinkedIn"]
+    end
+
+  private
+
+    def facebook_metrics
+      @facebook_metrics ||= response["Facebook"].is_a?(Hash) ? response["Facebook"] : Hash.new(0)
+    end
+
+    def response
+      @response ||= begin
+        endpoint = @use_ssl ? HTTPS_ENDPOINT : HTTP_ENDPOINT
+        begin
+          uri = URI("#{endpoint}?url=#{@url}")
+          res = Net::HTTP.get_response(uri)
+
+          case res
+          when Net::HTTPUnauthorized, Net::HTTPBadRequest then
+            json = JSON.parse(res.body)
+            raise Error.new(json["Type"], json["Error"])
+          when Net::HTTPSuccess then
+            JSON.parse(res.body)
+          end
+        rescue URI::InvalidURIError
+          raise INVALID_URL
+        end
+      end
+    end
+  end
+end

data/shared_count_api.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shared_count_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shared_count_api"
+  spec.version       = SharedCountApi::VERSION
+  spec.authors       = ["Cristian Rasch"]
+  spec.email         = ["cristianrasch@gmail.com"]
+  spec.description   = %q{Thin wrapper around the SharedCount API in vanilla Ruby}
+  spec.summary       = %q{This library wraps the SharedCount API exposing its data through POROs (Plain Old Ruby Objects)}
+  spec.homepage      = "https://github.com/wecodeio/shared_count_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "minitest", "~> 5.0.8"
+  spec.add_development_dependency "minitest-line", "~> 0.5.0"
+  spec.add_development_dependency "webmock", "~> 1.16.0"
+end

data/spec/shared_count_api_spec.rb

@@ -0,0 +1,118 @@
+require "bundler/setup"
+require "minitest/autorun"
+require "minitest/pride"
+require "webmock/minitest"
+require "uri"
+require "json"
+require "pathname"
+
+require_relative "../lib/shared_count_api"
+
+describe SharedCountApi::Client do
+  let(:url) { "http://slashdot.org" }
+  let(:body) do
+    { StumbleUpon: 603192, Reddit: 0,
+      Facebook: { commentsbox_count: 15, click_count: 27523, total_count: 335835, comment_count: 100278,
+                  like_count: 84709, share_count: 150848},
+      Delicious: 11969, GooglePlusOne: 76352, Buzz: 0, Twitter: 22199, Diggs: 0, Pinterest: 16081,
+      LinkedIn: 1532 }
+  end
+  subject { SharedCountApi::Client.new(url) }
+
+  describe "when the free API quota has been exceeded" do
+    before do
+      body = { "Error" => "Free API quota exceeded by more than 50%. Quota will reset tomorrow. Contact SharedCount to inquire about paid plans. http://sharedcount.com/quota",
+               "Type" => "quota_exceeded" }
+      stub_request(:get, Regexp.new(SharedCountApi::Client::HTTP_ENDPOINT)).
+        to_return(body: JSON.generate(body), status: 401, headers: { "X-IP-Quota-Remaining" => 0 })
+
+    end
+
+    it "raises the appropriate error" do
+      proc {
+        subject.stumble_upon
+      }.must_raise SharedCountApi::Error
+    end
+  end
+
+  describe "when the provided URL is invalid" do
+    before do
+      body = { "Error" => "Not a valid URL.", "Type" => "invalid_url" }
+      stub_request(:get, Regexp.new(SharedCountApi::Client::HTTP_ENDPOINT)).
+        to_return(body: JSON.generate(body), status: 400)
+
+    end
+
+    let(:url) { "invalid url" }
+
+    it "raises the appropriate error" do
+      proc {
+        subject.stumble_upon
+      }.must_raise SharedCountApi::Error
+    end
+  end
+
+  describe "when security is of the utmost importance" do
+    subject { SharedCountApi::Client.new(url, true) }
+    before do
+      stub_request(:get, Regexp.new(SharedCountApi::Client::HTTPS_ENDPOINT)).
+        to_return(body: JSON.generate(body))
+    end
+
+    it "makes requests over SSL" do
+      subject.stumble_upon.must_equal body[:StumbleUpon]
+    end
+  end
+
+  describe "when the request succeeds" do
+    before do
+      stub_request(:get, Regexp.new(SharedCountApi::Client::HTTP_ENDPOINT)).
+        to_return(body: JSON.generate(body))
+    end
+
+    it "includes the number of StumbleUpon shares" do
+      subject.stumble_upon.must_equal body[:StumbleUpon]
+    end
+
+    it "includes the number of Reddit shares" do
+      subject.reddit.must_equal body[:Reddit]
+    end
+
+    it "includes the number of Facebook likes" do
+      subject.facebook_like_count.must_equal body[:Facebook][:like_count]
+    end
+
+    it "includes the number of Facebook shares" do
+      subject.facebook_share_count.must_equal body[:Facebook][:share_count]
+    end
+
+    it "includes the number of Delicious shares" do
+      subject.delicious.must_equal body[:Delicious]
+    end
+
+    it "includes the number of Google +1s" do
+      subject.google_plus_one.must_equal body[:GooglePlusOne]
+    end
+
+    it "includes the number of Buzz shares" do
+      subject.buzz.must_equal body[:Buzz]
+    end
+
+    it "includes the number of Twitter shares" do
+      subject.twitter.must_equal body[:Twitter]
+    end
+
+    it "includes the number of Digg shares" do
+      subject.diggs.must_equal body[:Diggs]
+    end
+
+    it "includes the number of Pinterest shares" do
+      subject.pinterest.must_equal body[:Pinterest]
+    end
+
+    it "includes the number of LinkedIn shares" do
+      subject.linked_in.must_equal body[:LinkedIn]
+    end
+  end
+end
+

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: shared_count_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cristian Rasch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.8
+- !ruby/object:Gem::Dependency
+  name: minitest-line
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.16.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.16.0
+description: Thin wrapper around the SharedCount API in vanilla Ruby
+email:
+- cristianrasch@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/shared_count_api.rb
+- lib/shared_count_api/version.rb
+- shared_count_api.gemspec
+- spec/shared_count_api_spec.rb
+homepage: https://github.com/wecodeio/shared_count_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: This library wraps the SharedCount API exposing its data through POROs (Plain
+  Old Ruby Objects)
+test_files:
+- spec/shared_count_api_spec.rb