awesm 0.1.7 → 0.1.8

data/.gitignore

@@ -3,3 +3,4 @@
 Gemfile.lock
 pkg/*
 .DS_Store
+tags

data/README.md

@@ -1,10 +1,12 @@
 # Awesm #
 
-The *awesm* gem is an easy way to access the awe.sm API (http://totally.awe.sm).
+The *awesm* gem is an easy way to access the awe.sm API (http://developers.awe.sm).
+
+You can find the YARD documentation for the latest release here: http://rdoc.info/github/sfsekaran/awesm/frames
 
 We're actively developing this (and it's not yet production ready) but please
-feel free to send us a pull request from a topic branch with specs and an
-explanation :)
+feel free to send us a pull request from a topic branch with specs,
+documentation, and an explanation :)
 
 ## Usage ##
 
@@ -19,17 +21,47 @@ And in your code:
     Awesm.application_key = 'app-xxxxxx'
 
     # Create a project
-    project = Awesm::Project.create(:name => 'TotallyAwesm')
+    project = Awesm::Project.create({
+      :name => "myNewProject",
+      :domains => [
+        "examp.le",
+        "demo.examp.le"
+      ],
+      :default_domain => "examp.le",
+      :admins => [
+        "jeremiah"
+      ],
+      :sharers => [
+        "paul@example.com"
+      ],
+      :viewers => [
+        "9x69x9x0-42x1-420x-9876-123139064x99"
+      ],
+      :conversions => {
+        :enabled => true,
+        :domains => [
+          "example.com",
+          "www.example.com",
+          "example.net"
+        ],
+        :goal_1_label => "Liked our Facebook Page",
+        :goal_2_label => "Downloaded Photo of the Day",
+        :goal_3_label => "Purchase"
+      }
+    })
     project.api_key # => '5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9'
     # or
     project = Awesm::Project.new(:name => 'TotallyAwesm')
     project.save # => true
-    project.api_key # => '5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9'
+    project.api_key # => '5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045e9'
 
     # List projects
     projects = Awesm::Project.list
     projects.first.class # => Awesm::Project
 
+    # Delete a project
+    project.destroy # => true
+
     # Notify Awe.sm of a goal conversion
     Awesm::Conversion.convert(
       :key => "f2d8aeb112f1e0bedd7c05653e3265d2622635a3180f336f73b172267f7fe6ee",
@@ -51,6 +83,15 @@ And in your code:
     )
     # => "http://api.awe.sm/url/share?v=3&url=http://developers.awe.sm/&key=5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9&tool=mKU7uN&channel=twitter&destination=http://twitter.com/intent/tweet?text=This+is+the+coolest+API+evar!%26url=AWESM_URL%26via=awesm&parent=awe.sm_s5d99&user_id=42"
 
+    # Create a static link
+    Awesm::Url.static(
+      :format => 'json',
+      :url => 'http://developers.awe.sm/',
+      :key => '5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9',
+      :tool => 'mKU7uN'
+    )
+    # => "http://api.awe.sm/url/static.json?v=3&url=http://developers.awe.sm/&key=5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9&tool=mKU7uN"
+
     # Retrieve stats in return for your hard work!
     stats = Awesm::Stats.range(
       :key        => '5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9',
@@ -59,13 +100,19 @@ And in your code:
     )
     stats.totals.clicks # => 1024
 
+    url_stats = Awesm::Stats.url(
+      :key => '5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9',
+      :awesm_id => 'demo.awe.sm_K7e'
+    )
+    url_stats.clicks # => 256
+
 ## Contributing ##
 
 * fork
 * clone
 * bundle install
 * bundle exec rspec spec
-* commit code with passing specs
+* commit code with passing specs and documentation
 * push to a topic branch
 * send us a pull request :)
 

data/lib/awesm/project.rb

@@ -2,6 +2,7 @@ module Awesm
   class Project < Hashie::Mash
     include HTTParty
     base_uri 'http://api.awe.sm/projects'
+    format :json
 
     def self.create(attributes)
       project = self.new(attributes)
@@ -36,5 +37,10 @@ module Awesm
         true
       end
     end
+
+    def destroy
+      response = self.class.post("/#{api_key}/destroy", :query => { :application_key => Awesm.application_key, :subscription_key => Awesm.subscription_key })
+      true unless response.has_key?('error')
+    end
   end
 end

data/lib/awesm/stats.rb

@@ -6,11 +6,13 @@ module Awesm
 
     def self.range(options)
       response = get '/range.json', :query => { :v => 3 }.merge(options)
-      if response.has_key?('error')
-        nil
-      else
-        new(response)
-      end
+      new(response)
+    end
+
+    def self.url(options)
+      awesm_id = options.delete(:awesm_id)
+      response = get "/#{awesm_id}.json", :query => { :v => 3 }.merge(options)
+      new(response)
     end
   end
 end

data/lib/awesm/url.rb

@@ -1,9 +1,10 @@
 module Awesm
   class Url
     REQUIRED_SHARE_PARAMS = [:url, :key, :tool, :channel, :destination].freeze
+    REQUIRED_STATIC_PARAMS = [:format, :url, :key, :tool].freeze
 
     def self.share(params = {})
-      if required_params_present_for_share?(params)
+      if required_params_present?(REQUIRED_SHARE_PARAMS, params)
         options = params.clone
         options = options.delete_if{|key,value| REQUIRED_SHARE_PARAMS.include?(key) }
         query = options.map{|k,v| "#{k}=#{v}"}.join('&')
@@ -13,8 +14,19 @@ module Awesm
       end
     end
 
-    def self.required_params_present_for_share?(params)
-      REQUIRED_SHARE_PARAMS.all? do |param|
+    def self.static(params = {})
+      if required_params_present?(REQUIRED_STATIC_PARAMS, params)
+        options = params.clone
+        options = options.delete_if{|key,value| REQUIRED_STATIC_PARAMS.include?(key) }
+        query = options.map{|k,v| "#{k}=#{v}"}.join('&')
+        static_url = "http://api.awe.sm/url/static.#{params[:format]}?v=3&url=#{params[:url]}&key=#{params[:key]}&tool=#{params[:tool]}"
+        static_url += "&#{query}" if query.length > 0
+        static_url
+      end
+    end
+
+    def self.required_params_present?(required_params, params)
+      required_params.all? do |param|
         params.include?(param)
       end
     end

data/lib/awesm/version.rb

@@ -1,3 +1,3 @@
 module Awesm
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

data/spec/awesm/project_spec.rb

@@ -53,6 +53,21 @@ describe Awesm::Project do
     }.to_json
   end
 
+  let(:delete_project_response) do
+    {
+      :request => {
+        :apikey => "9x863xx7xx12x56433059xx8091838f5f5589x71x04f4760490x6x79xx9xx681",
+        :subscription_key => "sub-xxxxxx",
+        :application_key => "app-xxxxxx",
+        :object => "project",
+        :method => "delete"
+      },
+      :response => {
+        :deleted => true
+      }
+    }.to_json
+  end
+
   context '.create' do
     before do
       stub_request(:post, "http://api.awe.sm/projects/new?json=%7B%22name%22:%22TotallyAwesomeProject%22%7D&subscription_key=sub-xxxxxx&application_key=app-xxxxxx").
@@ -136,6 +151,27 @@ describe Awesm::Project do
     it 'does not update a project in awe.sm if it exists and attributes have not changed'
   end
 
+  describe "#destroy" do
+    let(:existing_project) { Awesm::Project.new(:name => 'ExistingAwesomeProject', :api_key => '9x863xx7xx12x56433059xx8091838f5f5589x71x04f4760490x6x79xx9xx681') }
+
+    before do
+      stub_request(:post, "http://api.awe.sm/projects/9x863xx7xx12x56433059xx8091838f5f5589x71x04f4760490x6x79xx9xx681/destroy?application_key=app-xxxxxx&subscription_key=sub-xxxxxx").
+         to_return(:status => 200, :body => delete_project_response, :headers => {})
+    end
+
+    it 'posts to the project destroy api' do
+      existing_project.destroy
+
+      a_request(:post, "http://api.awe.sm/projects/#{existing_project.api_key}/destroy").
+        with(:query => {:subscription_key => "sub-xxxxxx", :application_key => "app-xxxxxx"}).
+        should have_been_made.once
+    end
+
+    it 'returns true on success' do
+      existing_project.destroy.should == true
+    end
+  end
+
   describe '.list' do
     let(:list_project_response) do
       {

data/spec/awesm/stats_spec.rb

@@ -1,6 +1,13 @@
 require 'spec_helper'
 
 describe Awesm::Stats do
+  let(:invalid_key_response) do
+    {
+      "error" => 403,
+      "error_message" => "Invalid API key specified"
+    }.to_json
+  end
+
   describe '.range' do
     let(:basic_response) do
       {
@@ -30,13 +37,6 @@ describe Awesm::Stats do
       }.to_json
     end
 
-    let(:invalid_key_response) do
-      {
-        "error" => 403,
-        "error_message" => "Invalid API key specified"
-      }.to_json
-    end
-
     before do
       stub_request(:get, "http://api.awe.sm/stats/range.json?v=3&end_date=2011-10-01&key=5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9&start_date=2011-09-01").
         to_return(:status => 200, :body => basic_response, :headers => { 'Content-Type' => 'application/json;charset=utf-8' })
@@ -72,13 +72,22 @@ describe Awesm::Stats do
         should have_been_made.once
     end
 
-    it 'gets with an incorrect key' do
+    it 'returns an error code when using an incorrect key' do
       stats = Awesm::Stats.range(
         :key        => 'fake_key',
         :start_date => '2011-09-01',
         :end_date   => '2011-10-01'
       )
-      stats.should == nil
+      stats.error.should == 403
+    end
+
+    it 'returns an error code when using an incorrect key' do
+      stats = Awesm::Stats.range(
+        :key        => 'fake_key',
+        :start_date => '2011-09-01',
+        :end_date   => '2011-10-01'
+      )
+      stats.error_message.should == 'Invalid API key specified'
     end
 
     it 'returns an instance of Awesm::Stats' do
@@ -90,4 +99,51 @@ describe Awesm::Stats do
       stats.should be_an_instance_of(Awesm::Stats)
     end
   end
+
+  describe '.url' do
+    let(:stats_response) do
+      {
+        "awesm_id"         => "demo.awe.sm_K7e",
+        "clicks"           => 5,
+        "end_date"         => nil,
+        "interval"         => "none",
+        "start_date"       => nil,
+        "with_conversions" => false,
+        "with_metadata"    => false,
+        "with_zeros"       => false
+      }.to_json
+    end
+
+    before do
+      stub_request(:get, "http://api.awe.sm/stats/demo.awe.sm_K7e.json").
+        with(:query => { :v => '3', :key => '5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9' }).
+        to_return(:status => 200, :body => stats_response, :headers => {})
+      stub_request(:get, "http://api.awe.sm/stats/demo.awe.sm_K7e.json").
+        with(:query => { :v => '3', :key => 'wrong' }).
+        to_return(:status => 200, :body => invalid_key_response, :headers => {})
+    end
+
+    it 'should make the correct api call' do
+      Awesm::Stats.url(:key => '5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9', :awesm_id => 'demo.awe.sm_K7e')
+
+      a_request(:get, 'http://api.awe.sm/stats/demo.awe.sm_K7e.json').
+        with(:query => { :v => '3', :key => '5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9' }).
+        should have_been_made.once
+    end
+
+    it 'should return an instance of Awesm::Stats' do
+      stats = Awesm::Stats.url(:key => '5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9', :awesm_id => 'demo.awe.sm_K7e')
+      stats.should be_an_instance_of(Awesm::Stats)
+    end
+
+    it 'should return an error code with incorrect request info' do
+      stats = Awesm::Stats.url(:key => 'wrong', :awesm_id => 'demo.awe.sm_K7e')
+      stats.error.should == 403
+    end
+
+    it 'should return an error message with incorrect request info' do
+      stats = Awesm::Stats.url(:key => 'wrong', :awesm_id => 'demo.awe.sm_K7e')
+      stats.error_message.should == 'Invalid API key specified'
+    end
+  end
 end

data/spec/awesm/url_spec.rb

@@ -54,5 +54,58 @@ describe Awesm::Url do
     end
 
   end
+
+  describe '.static' do
+    let(:required_parameters) do
+      {
+        :format => 'json',
+        :url => 'http://developers.awe.sm/',
+        :key => '5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9',
+        :tool => 'mKU7uN'
+      }
+    end
+
+    it 'returns the correct static awe.sm url when passed the required parameters' do
+      Awesm::Url.static(:format => 'json',
+                       :url => 'http://developers.awe.sm/',
+                       :key => '5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9',
+                       :tool => 'mKU7uN').
+        should == 'http://api.awe.sm/url/static.json?v=3&url=http://developers.awe.sm/&key=5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9&tool=mKU7uN'
+    end
+
+    it 'returns nil if it receives an empty hash' do
+      Awesm::Url.static({}).should == nil
+    end
+
+    it 'returns nil if it receives nothing' do
+      Awesm::Url.static.should == nil
+    end
+
+    [[:channel,              'twitter'],
+     [:campaign,             'my-campaign-1'],
+     [:campaign_description, 'This is a description. Fun.'],
+     [:campaign_name,        'My Campaign 1'],
+     [:notes,                'This link is going to take down my site.'],
+     [:parent,               'awe.sm_s5d99'],
+     [:service_userid,       'twitter:13263'],
+     [:tag,                  'My-Tag'],
+     [:user_id,              '42']].each do |option, value|
+      it "returns the correct static awe.sm url when also passed a '#{option.to_s}' parameter" do
+        Awesm::Url.static(required_parameters.merge(option => value)).
+          should == "http://api.awe.sm/url/static.json?v=3&url=http://developers.awe.sm/&key=5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9&tool=mKU7uN&#{option.to_s}=#{value}"
+      end
+    end
+
+    it "accepts user_id related parameters" do
+      url = Awesm::Url.static(required_parameters.merge(
+        :user_id             => 42,
+        :user_id_icon_url    => 'http://test.com/users/42/avatar.png',
+        :user_id_profile_url => 'http://test.com/users/42/',
+        :user_id_username    => 'johndoe@test.com'
+      ))
+      url.should == "http://api.awe.sm/url/static.json?v=3&url=http://developers.awe.sm/&key=5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9&tool=mKU7uN&user_id=42&user_id_icon_url=http://test.com/users/42/avatar.png&user_id_profile_url=http://test.com/users/42/&user_id_username=johndoe@test.com"
+    end
+
+  end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: awesm
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 11
   prerelease: 
   segments: 
   - 0
   - 1
-  - 7
-  version: 0.1.7
+  - 8
+  version: 0.1.8
 platform: ruby
 authors: 
 - Sathya Sekaran
@@ -16,11 +16,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-14 00:00:00 Z
+date: 2012-04-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  name: rake
   prerelease: false
-  type: :development
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -30,11 +30,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: rake
+  type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
+  name: rspec
   prerelease: false
-  type: :development
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -44,11 +44,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: rspec
+  type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
+  name: webmock
   prerelease: false
-  type: :development
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -58,11 +58,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: webmock
+  type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
+  name: httparty
   prerelease: false
-  type: :development
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -72,11 +72,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: httparty
+  type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
+  name: json
   prerelease: false
-  type: :development
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -86,11 +86,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: json
+  type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
+  name: hashie
   prerelease: false
-  type: :development
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -100,11 +100,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: hashie
+  type: :development
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
+  name: ruby-debug
   prerelease: false
-  type: :development
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -114,11 +114,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: ruby-debug
+  type: :development
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
+  name: httparty
   prerelease: false
-  type: :runtime
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -128,11 +128,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: httparty
+  type: :runtime
   version_requirements: *id008
 - !ruby/object:Gem::Dependency 
+  name: json
   prerelease: false
-  type: :runtime
   requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -142,11 +142,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: json
+  type: :runtime
   version_requirements: *id009
 - !ruby/object:Gem::Dependency 
+  name: hashie
   prerelease: false
-  type: :runtime
   requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -156,7 +156,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: hashie
+  type: :runtime
   version_requirements: *id010
 description: The 'awesm' gem is an interface for awe.sm (http://totally.awe.sm), a social link analytics tracking service.
 email: 
@@ -217,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: awesm
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Totally awe.sm!