add_this 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rake_tasks~

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2@add_this --create

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in add_this.gemspec
+gemspec
+

data/Guardfile

@@ -0,0 +1,6 @@
+# Get Those Automated Test
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 General Things Inc.
+
+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,75 @@
+# Add This
+
+Ruby wrapper for the [Add This Analytics API](http://www.addthis.com/help/analytics-api#.TzzlN0zC4V).
+
+## Installation
+
+```bash
+$ gem i add_this
+```
+
+## Usage
+
+With your user_id and password define a configure block that defines them like so:
+
+### Global Config
+
+```ruby
+AddThis.configure do |config|
+  config.user_id = "generalthings"
+  config.password = "awesome"
+end
+```
+
+### or Per Request
+
+```ruby
+add_this = AddThis::Client.new(user_id: "generalthings", password: "awesome")
+```
+
+For making requests to the api is quite simple it follows most of the current Add 
+This Structure for urls only broken by an underscore so [/shares/day](https://api.addthis.com/analytics/1.0/pub/shares/day.csv)
+would be a method called `shares_day`
+
+
+## Example calls
+
+You have two ways available to get data one on the AddThis class like so:
+
+```ruby
+AddThis.get.shares_url
+```
+
+or by creating the client and requesting through that like so:
+
+```ruby
+add_this = AddThis::Client.new
+add_this.shares_url
+```
+
+or passing query params you just need to provide a hash into that method as so:
+
+```ruby
+AddThis.get.shares_url({service: "facebook_like"})
+```
+
+
+Resources:
+
+* [Add This Analytics API](http://www.addthis.com/help/analytics-api#.TzzlN0zC4V)
+
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2012 General Things Inc. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec
+
+desc "Open an irb session preloaded with this library"
+task :console do
+    sh "irb -rubygems -I lib -I  extra -r add_this.rb"
+end

data/add_this.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "add_this/version"
+
+Gem::Specification.new do |s|
+  s.name        = "add_this"
+  s.version     = AddThis::VERSION
+  s.authors     = ["Christopher Hein", "Ryan Van Niekerk", "Nick Hodulik"]
+  s.email       = ["chris@generalthings.com", "rvanniekerk@generalthings.com", "nick@generalthings.com"]
+  s.homepage    = ""
+  s.summary     = %q{Simple API connector for getting analytic data from AddThis}
+  s.description = %q{Simple API connector for getting analytic data from AddThis}
+
+  s.rubyforge_project = "add_this"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_runtime_dependency "faraday"
+  s.add_runtime_dependency "faraday_middleware"
+  s.add_runtime_dependency "hashie"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "guard"
+  s.add_development_dependency "guard-rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/add_this/client.rb

@@ -0,0 +1,66 @@
+# Client Class
+#
+# builds a base class for all the api calls
+# to inherit from.
+
+require "add_this/requests"
+
+module AddThis
+
+  class Client
+    # include all other classes to inherit from
+    include Requests
+
+    attr_accessor :user_id, :password
+
+    # Creating the base client
+    #
+    # @option opts [String] :user_id login for Add This
+    # @option opts [String] :password password for Add This
+    #
+    # @example
+    #   AddThis::Client.new
+    def initialize(opts = {})
+      @user_id    = opts[:user_id]  || AddThis.configuration.user_id
+      @password   = opts[:password] || AddThis.configuration.password
+      connection.basic_auth(@user_id, @password)
+    end
+
+    # Creates a Faraday connection block
+    #
+    # @return [Faraday::Connection]
+    def connection
+      @connection ||= Faraday.new(url: base_url, headers: default_headers, ssl: {verify: false}) do |builder|
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Response::Mashify
+        builder.use Faraday::Response::ParseJson
+        builder.adapter Faraday.default_adapter
+      end
+    end
+    
+    protected
+
+      # @protected
+      def base_url
+        "https://api.addthis.com/analytics/1.0/pub/"
+      end
+
+      # @protected
+      def default_headers
+        {
+          accept:  'application/json',
+          user_agent: 'Ruby gem',
+        }
+      end
+
+  end
+  
+  class << self
+    attr_accessor :client
+  end
+
+  def self.get
+    self.client ||= Client.new
+  end
+
+end

data/lib/add_this/configuration.rb

@@ -0,0 +1,45 @@
+# Configuration Class
+#
+# this allows to you to setup all your configuration
+# params through an initializer such as:
+#
+# config/initializers/add_this.rb
+#
+# @example
+#   AddThis.configure do
+#     config.user_id    = "generalthings"
+#     config.password   = "password"
+#   end
+
+module AddThis
+
+  class Configuration
+
+    # Define the available methods
+    attr_accessor :user_id, :password
+
+    def initialize
+      @user_id    = "generalthings"
+      @password   = "password"
+    end
+  end
+
+  # Defines configuration method to allow
+  # Configuration.new to be stored on the 
+  # global object
+  class << self
+    attr_accessor :configuration
+  end
+
+  # Allows you to build a configure block
+  #
+  # @option options [String] :user_id login to Add This
+  # @option options [String] :password password to Add This
+  # @return [Boolean]
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield configuration
+    true
+  end
+
+end

data/lib/add_this/requests.rb

@@ -0,0 +1,27 @@
+module AddThis
+
+  module Requests
+
+    def self.requests(*args)
+      args.each do |arg|
+        define_method arg do |*options|
+          metric, dimension = arg.to_s.split("_")
+          connection.get("/analytics/1.0/pub/shares/url.json", options[0]).body
+        end
+      end
+    end
+
+    requests :shares_day, :shares_url, :shares_domain, :shares_service, 
+             :shares_interest, :shares_continent, :shares_country, :clicks_day,
+             :clicks_url, :clicks_domain, :clicks_service, :clicks_interest, 
+             :clicks_continent, :clicks_country, :subscriptions_day, :subscriptions_url,
+             :subscriptions_domain, :subscriptions_service, :subscriptions_interest,
+             :subscriptions_continent, :subscriptions_country, :sharers_day, 
+             :sharers_interest, :influencers_day, :influencers_interest, :clickers_day,
+             :clickers_interest, :users_day, :users_interest, :searches_term, 
+             :referers_domain
+
+
+  end
+
+end

data/lib/add_this/version.rb

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

data/lib/add_this.rb

@@ -0,0 +1,5 @@
+require "faraday"
+require "faraday_middleware"
+require "add_this/version"
+require "add_this/configuration"
+require "add_this/client"

data/spec/add_this/client_spec.rb

@@ -0,0 +1,99 @@
+require "spec_helper"
+
+describe AddThis::Client do
+  before(:each) do
+    AddThis.configure do |config|
+      config.user_id    = "chris"
+      config.password   = "hein"
+    end
+  end
+  let(:client) { AddThis::Client.new }
+  
+  context "instantiation" do
+
+    it "should have a new method" do
+      AddThis::Client.should respond_to :new
+    end
+
+  end
+
+  context "attrs" do
+    let(:client) { AddThis::Client.new({user_id: "chris", password: "hein"}) }
+    
+    it "should have user_id attr" do
+      client.should respond_to :user_id
+    end
+
+    it "should have password attr" do
+      client.should respond_to :password
+    end
+  
+  end
+  
+  context "setting the attributes" do
+    let(:params) { { user_id: "chris", password: "password" } }
+    let(:client) { AddThis::Client.new(params) }
+    
+    it "should have set the user_id" do
+      client.user_id.should eq "chris"
+    end
+
+    it "should have set the password" do
+      client.password.should eq "password"
+    end
+
+  end
+
+  context "loading them from config block" do
+
+    it "should have set the user_id" do
+      client.user_id.should eq "chris"
+    end
+
+    it "should have set the password" do
+      client.password.should eq "hein"
+    end
+
+  end
+
+  context "setting up the connection" do
+    let(:connection) { client.connection }
+    
+    it "should respond to connection" do
+      client.should respond_to :connection
+    end
+    
+    it "should return the base url" do
+      client.send(:base_url).should eq "https://api.addthis.com/analytics/1.0/pub/"
+    end
+    
+    it "should return a hash for default_headers" do
+      client.send(:default_headers).should be_kind_of Hash
+    end
+
+    it "should respond with a faraday connection" do
+      connection.should be_kind_of Faraday::Connection
+    end
+  end
+  
+  context "calling the API with out creating a new client" do
+
+    it "should respond_to :client" do
+      AddThis.should respond_to :client
+    end
+    
+    it "should respond_to :get" do
+      AddThis.should respond_to :get
+    end
+
+    it "should be able to make trailing requests" do
+      AddThis.get.should respond_to :shares_url
+    end
+
+    it "should be a kind of Faraday::Connection" do
+      AddThis.get.should be_kind_of AddThis::Client
+    end
+
+  end
+
+end

data/spec/add_this/configuration_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+describe AddThis::Configuration do
+
+  let(:config) { AddThis::Configuration.new }
+  let(:configure) do
+    AddThis.configure do |config|
+      config.user_id    = "chris"
+      config.password   = "hein"
+    end
+  end
+  
+  context "instantiation" do
+
+    it "should have a new method" do
+      AddThis::Configuration.should respond_to :new
+    end
+
+    it "should return configuration object" do
+      configure.should eq true
+    end
+
+  end
+
+  context "attrs" do
+
+    it "should have a attr of user_id" do
+      config.should respond_to :user_id
+    end
+
+    it "should have an attr of password" do
+      config.should respond_to :password
+    end
+
+  end
+  
+  context "getting the attrs" do
+    
+    it "should have access to the configuration variables for user_id" do
+      AddThis.configuration.should respond_to :user_id
+    end
+
+    it "should have access to the configuration variables for password" do
+      AddThis.configuration.should respond_to :password
+    end
+
+    it "should have chris for user_id" do
+      AddThis.configuration.user_id.should eq "chris"
+    end
+
+    it "should have chris for password" do
+      AddThis.configuration.password.should eq "hein"
+    end
+
+  end
+
+  context "base class" do
+
+    it "should have an attribute of configuration" do
+      AddThis.should respond_to :configuration
+    end
+    
+    it "should have a method for configure" do
+      AddThis.should respond_to :configure
+    end
+
+  end
+
+end

data/spec/add_this/requests_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+class DummyClass; end
+
+describe AddThis::Requests do
+  let(:klass) { DummyClass.new }
+  let(:requests) { klass.extend(AddThis::Requests) }
+  
+  context "instantiation" do
+  end
+
+  context "defining api calls" do
+
+    it "should respond_to shares_day" do
+      requests.should respond_to :shares_day
+    end
+
+    it "should respond_to shares_url" do
+      requests.should respond_to :shares_url
+    end
+
+    it "should respond_to shares_domain" do
+      requests.should respond_to :shares_domain
+    end
+
+    it "should respond_to shares_service" do
+      requests.should respond_to :shares_service
+    end
+
+    it "should respond_to shares_interest" do
+      requests.should respond_to :shares_interest
+    end
+
+    it "should respond_to shares_continent" do
+      requests.should respond_to :shares_continent
+    end
+
+    it "should respond_to shares_country" do
+      requests.should respond_to :shares_country
+    end
+
+  end
+
+end

data/spec/add_this/version_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+describe AddThis do
+  
+  it "should have a version set" do
+    AddThis::VERSION.should_not eq nil
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "rubygems"
+require "bundler/setup"
+
+require "add_this"
+
+RSpec.configure do |config|
+
+  config.mock_with :rspec
+
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: add_this
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Christopher Hein
+- Ryan Van Niekerk
+- Nick Hodulik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-16 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70284673873900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70284673873900
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: &70284673873140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70284673873140
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &70284673871800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70284673871800
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70284673870500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70284673870500
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &70284673869820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70284673869820
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70284673869020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70284673869020
+description: Simple API connector for getting analytic data from AddThis
+email:
+- chris@generalthings.com
+- rvanniekerk@generalthings.com
+- nick@generalthings.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- add_this.gemspec
+- lib/add_this.rb
+- lib/add_this/client.rb
+- lib/add_this/configuration.rb
+- lib/add_this/requests.rb
+- lib/add_this/version.rb
+- spec/add_this/client_spec.rb
+- spec/add_this/configuration_spec.rb
+- spec/add_this/requests_spec.rb
+- spec/add_this/version_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: add_this
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Simple API connector for getting analytic data from AddThis
+test_files:
+- spec/add_this/client_spec.rb
+- spec/add_this/configuration_spec.rb
+- spec/add_this/requests_spec.rb
+- spec/add_this/version_spec.rb
+- spec/spec_helper.rb
+has_rdoc: