awesm 0.1.6 → 0.1.7

data/.gitignore

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

data/README.md

@@ -21,21 +21,44 @@ And in your code:
     # Create a project
     project = Awesm::Project.create(:name => 'TotallyAwesm')
     project.api_key # => '5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9'
+    # or
+    project = Awesm::Project.new(:name => 'TotallyAwesm')
+    project.save # => true
+    project.api_key # => '5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9'
 
     # List projects
     projects = Awesm::Project.list
     projects.first.class # => Awesm::Project
 
+    # Notify Awe.sm of a goal conversion
+    Awesm::Conversion.convert(
+      :key => "f2d8aeb112f1e0bedd7c05653e3265d2622635a3180f336f73b172267f7fe6ee",
+      :awesm_url => "awe.sm_5WXHo",
+      :conversion_type => "goal_1",
+      :conversion_value => 1230
+    )
+    # => #<Awesm::Conversion account_conversionid=nil account_id="12" account_userid=nil awesm_url="awe.sm_5WXHo" clicker_id=nil converted_at=1323475432 href=nil id="bfdaddec-2298-43fb-9da0-f12d81febbf6" ip_address=nil language=nil redirection_id="94585739" referrer=nil session_id=nil type="goal_1" user_agent=nil value=1230>
+
     # Create a sharing link
-    Awesm::Url.share(: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')
+    Awesm::Url.share(
+      :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'
+    )
     # => "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"
 
+    # Retrieve stats in return for your hard work!
+    stats = Awesm::Stats.range(
+      :key        => '5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9',
+      :start_date => '2011-09-01',
+      :end_date   => '2011-10-01'
+    )
+    stats.totals.clicks # => 1024
+
 ## Contributing ##
 
 * fork

data/lib/awesm.rb

@@ -6,6 +6,7 @@ require 'awesm/version'
 require 'awesm/project'
 require 'awesm/conversion'
 require 'awesm/url'
+require 'awesm/stats'
 
 module Awesm
   def self.subscription_key=(key)

data/lib/awesm/project.rb

@@ -4,12 +4,8 @@ module Awesm
     base_uri 'http://api.awe.sm/projects'
 
     def self.create(attributes)
-      response = post('/new', :query => { :application_key => Awesm.application_key, :subscription_key => Awesm.subscription_key, :json => attributes.to_json })
-      if response.has_key?("error")
-        nil
-      else
-        new(response['response']['project'])
-      end
+      project = self.new(attributes)
+      project.save ? project : nil
     end
 
     def self.list
@@ -24,5 +20,21 @@ module Awesm
         projects
       end
     end
+
+    ####################
+    # Instance Methods #
+    ####################
+
+    def save
+      response = self.class.post('/new', :query => { :application_key => Awesm.application_key, :subscription_key => Awesm.subscription_key, :json => self.to_hash.to_json })
+      if response.include?('error')
+        # use mash to update error code and message
+        update(response)
+        false
+      else
+        update(response['response']['project'])
+        true
+      end
+    end
   end
 end

data/lib/awesm/stats.rb

@@ -0,0 +1,16 @@
+module Awesm
+  class Stats < Hashie::Mash
+    include HTTParty
+    base_uri 'http://api.awe.sm/stats'
+    format :json
+
+    def self.range(options)
+      response = get '/range.json', :query => { :v => 3 }.merge(options)
+      if response.has_key?('error')
+        nil
+      else
+        new(response)
+      end
+    end
+  end
+end

data/lib/awesm/version.rb

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

data/spec/awesm/conversion_spec.rb

@@ -65,7 +65,7 @@ describe Awesm::Conversion do
           :key => "badkeyabcdefghijklmnopqrstuvwxyz1234567890",
           :awesm_url => "awe.sm_5WXHo",
           :conversion_type => "goal_1",
-          :conversion_value => "1230"
+          :conversion_value => 1230
         }
         conversion = Awesm::Conversion.convert(params)
         conversion.should == nil
@@ -78,7 +78,7 @@ describe Awesm::Conversion do
           :key => "f2d8aeb112f1e0bedd7c05653e3265d2622635a3180f336f73b172267f7fe6ee",
           :awesm_url => "awe.sm_5WXHo",
           :conversion_type => "goal_1",
-          :conversion_value => "1230"
+          :conversion_value => 1230
         }
 
         conversion = Awesm::Conversion.convert(params)
@@ -91,7 +91,7 @@ describe Awesm::Conversion do
           :key => "f2d8aeb112f1e0bedd7c05653e3265d2622635a3180f336f73b172267f7fe6ee",
           :awesm_url => "awe.sm_5WXHo",
           :conversion_type => "goal_1",
-          :conversion_value => "1230"
+          :conversion_value => 1230
         }
 
       conversion = Awesm::Conversion.convert(params)

data/spec/awesm/project_spec.rb

@@ -12,53 +12,53 @@ describe Awesm::Project do
     Awesm.application_key = nil
   end
 
-  context '.create' do
-    let(:json_response) do 
-      {
-        "request" => {
-          "application_key" => "app-xxxxxx",
-          "json" => "{\"name\" =>\"TotallyAwesomeProject\"}",
-          "method" => "new",
-          "object" => "project",
-          "subscription_key" => "sub-xxxxxx"
-        },
-        "response" => {
-          "project" => {
-            "admins" => [],
-            "api_key" => "6xxxxxxxxx58xx0xxx74xx3x76xx83x6x34xx48x7xxxx55x167037818d65x66x",
-            "created_at" => "2011-10-25 00:43:49",
-            "default_domain" => "awe.sm",
-            "domains" => [],
-            "name" => "TotallyAwesomeProject",
-            "sharers" => [],
-            "updated_at" => "2011-10-25 00:43:49",
-            "viewers" => []
-          }
+  let(:new_project_response) do
+    {
+      "request" => {
+        "application_key" => "app-xxxxxx",
+        "json" => "{\"name\" =>\"TotallyAwesomeProject\"}",
+        "method" => "new",
+        "object" => "project",
+        "subscription_key" => "sub-xxxxxx"
+      },
+      "response" => {
+        "project" => {
+          "admins" => [],
+          "api_key" => "6xxxxxxxxx58xx0xxx74xx3x76xx83x6x34xx48x7xxxx55x167037818d65x66x",
+          "created_at" => "2011-10-25 00:43:49",
+          "default_domain" => "awe.sm",
+          "domains" => [],
+          "name" => "TotallyAwesomeProject",
+          "sharers" => [],
+          "updated_at" => "2011-10-25 00:43:49",
+          "viewers" => []
         }
-      }.to_json
-    end
+      }
+    }.to_json
+  end
 
-    let(:json_error_response) do
-      {
-        "request" => {
-          "application_key" => "app-xxxxxx",
-          "json" => "{\"name\" =>\"ExistingAwesomeProject\"}",
-          "method" => "new",
-          "object" => "project",
-          "subscription_key" => "sub-xxxxxx"
-        },
-        "error" => {
-          "code" => 10001,
-          "message" => "Project name already exists (not necessarily in your subscription). Please choose another."
-        }
-      }.to_json
-    end
+  let(:new_project_error_response) do
+    {
+      "request" => {
+      "application_key" => "app-xxxxxx",
+      "json" => "{\"name\" =>\"ExistingAwesomeProject\"}",
+      "method" => "new",
+      "object" => "project",
+      "subscription_key" => "sub-xxxxxx"
+    },
+      "error" => {
+      "code" => 10001,
+      "message" => "Project name already exists (not necessarily in your subscription). Please choose another."
+    }
+    }.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").
-        to_return(:status => 200, :body => json_response, :headers => { 'Content-Type' => 'application/json;charset=utf-8' })
+        to_return(:status => 200, :body => new_project_response, :headers => { 'Content-Type' => 'application/json;charset=utf-8' })
       stub_request(:post, "http://api.awe.sm/projects/new?json=%7B%22name%22:%22ExistingAwesomeProject%22%7D&subscription_key=sub-xxxxxx&application_key=app-xxxxxx").
-        to_return(:status => 400, :body => json_error_response, :headers => { 'Content-Type' => 'application/json;charset=utf-8' })
+        to_return(:status => 400, :body => new_project_error_response, :headers => { 'Content-Type' => 'application/json;charset=utf-8' })
     end
 
     context 'when an error occurs' do
@@ -84,8 +84,60 @@ describe Awesm::Project do
     end
   end
 
+  describe '.new' do
+    it 'accepts project attributes' do
+      project = Awesm::Project.new(:name => 'HooHah')
+      project.name.should == 'HooHah'
+    end
+  end
+
+  describe '#save' 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").
+        to_return(:status => 200, :body => new_project_response, :headers => { 'Content-Type' => 'application/json;charset=utf-8' })
+      stub_request(:post, "http://api.awe.sm/projects/new?json=%7B%22name%22:%22ExistingAwesomeProject%22%7D&subscription_key=sub-xxxxxx&application_key=app-xxxxxx").
+        to_return(:status => 400, :body => new_project_error_response, :headers => { 'Content-Type' => 'application/json;charset=utf-8' })
+    end
+
+    let(:project) { Awesm::Project.new(:name => 'TotallyAwesomeProject') }
+    let(:existing_project) { Awesm::Project.new(:name => 'ExistingAwesomeProject') }
+
+    context 'with no existing projects' do
+      it 'calls the correct project/new api' do
+        project.save
+
+        a_request(:post, "http://api.awe.sm/projects/new").
+          with(:query => {:subscription_key => "sub-xxxxxx", :application_key => "app-xxxxxx", :json => { "name" => "TotallyAwesomeProject" }.to_json }).
+          should have_been_made.once
+      end
+
+      it 'returns true' do
+        project.save.should == true
+      end
+    end
+
+    context 'when the project already exists' do
+      it 'returns false' do
+        existing_project.save.should == false
+      end
+
+      it 'sets the error code' do
+        existing_project.save
+        existing_project.error.code.should == 10001
+      end
+
+      it 'sets the error message' do
+        existing_project.save
+        existing_project.error.message.should == 'Project name already exists (not necessarily in your subscription). Please choose another.'
+      end
+    end
+
+    it 'updates a project in awe.sm if it exists and attributes have changed'
+    it 'does not update a project in awe.sm if it exists and attributes have not changed'
+  end
+
   describe '.list' do
-    let(:json_response) do
+    let(:list_project_response) do
       {
         "request" => {
           "application_key" => "app-xxxxxx",
@@ -137,13 +189,13 @@ describe Awesm::Project do
       }.to_json
     end
 
-    let(:json_error_response) do
+    let(:list_project_error_response) do
       {
         "request" => {
-          "action" => "list", 
-          "subscription_key" => "butt", 
-          "application_key" => "tlVC3D", 
-          "controller" => "project" 
+          "action" => "list",
+          "subscription_key" => "butt",
+          "application_key" => "tlVC3D",
+          "controller" => "project"
         },
         "error" => "Invalid subscription key"
       }.to_json
@@ -151,9 +203,9 @@ describe Awesm::Project do
 
     before do
       stub_request(:post, "http://api.awe.sm/projects/list?subscription_key=sub-xxxxxx&application_key=app-xxxxxx").
-        to_return(:status => 200, :body => json_response, :headers => { 'Content-Type' => 'application/json;charset=utf-8' })
+        to_return(:status => 200, :body => list_project_response, :headers => { 'Content-Type' => 'application/json;charset=utf-8' })
       stub_request(:post, "http://api.awe.sm/projects/list?subscription_key=invalid&application_key=app-xxxxxx").
-        to_return(:status => 400, :body => json_error_response, :headers => { 'Content-Type' => 'application/json;charset=utf-8' })
+        to_return(:status => 400, :body => list_project_error_response, :headers => { 'Content-Type' => 'application/json;charset=utf-8' })
     end
 
     it 'posts to the awe.sm project list api properly' do
@@ -181,34 +233,9 @@ describe Awesm::Project do
   end
 
   describe '#api_key' do
-    let(:json_response) do 
-      {
-        "request" => {
-          "application_key" => "app-xxxxxx",
-          "json" => "{\"name\" =>\"TotallyAwesomeProject\"}",
-          "method" => "new",
-          "object" => "project",
-          "subscription_key" => "sub-xxxxxx"
-        },
-        "response" => {
-          "project" => {
-            "admins" => [],
-            "api_key" => "6xxxxxxxxx58xx0xxx74xx3x76xx83x6x34xx48x7xxxx55x167037818d65x66x",
-            "created_at" => "2011-10-25 00:43:49",
-            "default_domain" => "awe.sm",
-            "domains" => [],
-            "name" => "TotallyAwesomeProject",
-            "sharers" => [],
-            "updated_at" => "2011-10-25 00:43:49",
-            "viewers" => []
-          }
-        }
-      }.to_json
-    end
-
     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").
-        to_return(:status => 200, :body => json_response, :headers => { 'Content-Type' => 'application/json;charset=utf-8' })
+        to_return(:status => 200, :body => new_project_response, :headers => { 'Content-Type' => 'application/json;charset=utf-8' })
     end
 
     it 'returns the awe.sm api_key' do

data/spec/awesm/stats_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe Awesm::Stats do
+  describe '.range' do
+    let(:basic_response) do
+      {
+        "end_date" => "2011-10-01T00:00:00Z",
+        "filters" => [],
+        "group_by" => nil,
+        "groups" => [],
+        "last_offset" => 0,
+        "offset" => 0,
+        "page" => nil,
+        "per_page" => 10,
+        "pivot" => nil,
+        "pivot_sort_order" => nil,
+        "pivot_sort_type" => nil,
+        "sort_order" => nil,
+        "sort_type" => nil,
+        "start_date" => "2011-09-01T00:00:00Z",
+        "total_results" => 0,
+        "totals" => {
+          "clicks" => 166,
+          "clicks_per_share" => 2.5538,
+          "shares" => 65
+        },
+        "with_conversions" => false,
+        "with_metadata" => false,
+        "with_zeros" => false
+      }.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' })
+      stub_request(:get, "http://api.awe.sm/stats/range.json?v=3&end_date=2011-10-01&key=fake_key&start_date=2011-09-01").
+        to_return(
+          :status => 403,
+          :body => invalid_key_response,
+          :headers => {
+            "x-powered-by" => ["PHP/5.3.2-1ubuntu4.7"],
+            "connection"=>["close"],
+            "content-type"=>["text/html"],
+            "date"=>["Tue, 13 Dec 2011 18:51:20 GMT"],
+            "server"=>["Apache/2.2.14 (Ubuntu)"],
+            "content-length"=>["57"],
+            "vary"=>["Accept-Encoding"]
+          })
+    end
+
+    it 'gets the stats range api correctly' do
+      stats = Awesm::Stats.range(
+        :key        => '5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9',
+        :start_date => '2011-09-01',
+        :end_date   => '2011-10-01'
+      )
+
+      a_request(:get, "http://api.awe.sm/stats/range.json").
+        with(:query => {
+          :v          => '3',
+          :key        => '5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9',
+          :start_date => '2011-09-01',
+          :end_date   => '2011-10-01'
+        }).
+        should have_been_made.once
+    end
+
+    it 'gets with an incorrect key' do
+      stats = Awesm::Stats.range(
+        :key        => 'fake_key',
+        :start_date => '2011-09-01',
+        :end_date   => '2011-10-01'
+      )
+      stats.should == nil
+    end
+
+    it 'returns an instance of Awesm::Stats' do
+      stats = Awesm::Stats.range(
+        :key        => '5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9',
+        :start_date => '2011-09-01',
+        :end_date   => '2011-10-01'
+      )
+      stats.should be_an_instance_of(Awesm::Stats)
+    end
+  end
+end

data/spec/awesm/url_spec.rb

@@ -50,7 +50,7 @@ describe Awesm::Url do
         :user_id_profile_url => 'http://test.com/users/42/',
         :user_id_username    => 'johndoe@test.com'
       ))
-      url.should == "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&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&user_id=42"
+      url.should == "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&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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: awesm
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 1
-  - 6
-  version: 0.1.6
+  - 7
+  version: 0.1.7
 platform: ruby
 authors: 
 - Sathya Sekaran
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-08 00:00:00 Z
+date: 2011-12-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false
@@ -179,10 +179,12 @@ files:
 - lib/awesm.rb
 - lib/awesm/conversion.rb
 - lib/awesm/project.rb
+- lib/awesm/stats.rb
 - lib/awesm/url.rb
 - lib/awesm/version.rb
 - spec/awesm/conversion_spec.rb
 - spec/awesm/project_spec.rb
+- spec/awesm/stats_spec.rb
 - spec/awesm/url_spec.rb
 - spec/awesm_spec.rb
 - spec/spec_helper.rb
@@ -222,6 +224,7 @@ summary: Totally awe.sm!
 test_files: 
 - spec/awesm/conversion_spec.rb
 - spec/awesm/project_spec.rb
+- spec/awesm/stats_spec.rb
 - spec/awesm/url_spec.rb
 - spec/awesm_spec.rb
 - spec/spec_helper.rb