add_this 0.0.1 → 0.0.2

data/lib/add_this/client.rb

@@ -2,6 +2,14 @@
 #
 # builds a base class for all the api calls
 # to inherit from.
+#
+# @example
+#   add_this = AddThis::Client.new
+#   add_this.shares_url
+#
+# @example
+#   AddThis.get.shares_url
+#
 
 require "add_this/requests"
 
@@ -56,9 +64,11 @@ module AddThis
   end
   
   class << self
+    # attrs for storing the client object
     attr_accessor :client
   end
 
+  # defining the client object so you can make requests on the AddThis class
   def self.get
     self.client ||= Client.new
   end

data/lib/add_this/requests.rb

@@ -1,16 +1,30 @@
+# Request module
+#
+# gets included in the client this is were all the actual api calls are created
+
 module AddThis
 
   module Requests
-
+    
+    # requests method
+    #
+    # Defines the get request for all the methods by splitting the method name
+    # and the underscore to keep things dry as well allows your to pass a hash 
+    # for all the query params
+    #
+    # @option args [Array] all of the symbolized method names
     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
+          connection.get("/analytics/1.0/pub/#{metric}/#{dimension}.json", options[0]).body
         end
       end
     end
-
+  
+    # Requests
+    #
+    # All availble methods that will hit the api
     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, 

data/lib/add_this/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: add_this
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -15,7 +15,7 @@ date: 2012-02-16 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70284673873900 !ruby/object:Gem::Requirement
+  requirement: &70175978315520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70284673873900
+  version_requirements: *70175978315520
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &70284673873140 !ruby/object:Gem::Requirement
+  requirement: &70175978314760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70284673873140
+  version_requirements: *70175978314760
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70284673871800 !ruby/object:Gem::Requirement
+  requirement: &70175978313860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70284673871800
+  version_requirements: *70175978313860
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70284673870500 !ruby/object:Gem::Requirement
+  requirement: &70175978313260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70284673870500
+  version_requirements: *70175978313260
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70284673869820 !ruby/object:Gem::Requirement
+  requirement: &70175978312720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70284673869820
+  version_requirements: *70175978312720
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70284673869020 !ruby/object:Gem::Requirement
+  requirement: &70175978312160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,7 +78,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70284673869020
+  version_requirements: *70175978312160
 description: Simple API connector for getting analytic data from AddThis
 email:
 - chris@generalthings.com