awesm 0.1.5 → 0.1.6

data/README.md

@@ -22,14 +22,19 @@ And in your code:
     project = Awesm::Project.create(:name => 'TotallyAwesm')
     project.api_key # => '5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9'
 
+    # List projects
+    projects = Awesm::Project.list
+    projects.first.class # => Awesm::Project
+
     # Create a sharing link
-    # (This is currently very rudimentary--only the options shown will work.)
     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')
-    # => "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"
+                     :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"
 
 ## Contributing ##
 
@@ -41,10 +46,11 @@ And in your code:
 * push to a topic branch
 * send us a pull request :)
 
-## Manitainers ##
+## Contributors ##
 
 * *Sathya Sekaran*
 * *Michael Durnhofer*
+* *Cody Johnston*
 
 ## Many Thanks To ##
 * our employer, Topspin Media, Inc. (http://topspinmedia.com)

data/lib/awesm/project.rb

@@ -11,5 +11,18 @@ module Awesm
         new(response['response']['project'])
       end
     end
+
+    def self.list
+      response = post('/list', :query => { :application_key => Awesm.application_key, :subscription_key => Awesm.subscription_key})
+      if response.has_key?("error")
+        nil
+      else
+        projects = []
+        response['response']['projects'].each do |project|
+          projects << new(project)
+        end
+        projects
+      end
+    end
   end
 end

data/lib/awesm/url.rb

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

data/lib/awesm/version.rb

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

data/spec/awesm/project_spec.rb

@@ -1,61 +1,66 @@
 require 'spec_helper'
 
 describe Awesm::Project 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
-
-  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
 
   before do
     Awesm.subscription_key = 'sub-xxxxxx'
     Awesm.application_key = 'app-xxxxxx'
-    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' })
-    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' })
   end
+
   after do
     Awesm.subscription_key = nil
     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" => []
+          }
+        }
+      }.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
+
+    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' })
+      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' })
+    end
+
     context 'when an error occurs' do
       it 'returns nil' do
         project = Awesm::Project.create(:name => "ExistingAwesomeProject")
@@ -79,7 +84,133 @@ describe Awesm::Project do
     end
   end
 
+  describe '.list' do
+    let(:json_response) do
+      {
+        "request" => {
+          "application_key" => "app-xxxxxx",
+          "method" => "list",
+          "object" => "project",
+          "subscription_key" => "sub-xxxxxx"
+        },
+        "response" => {
+          "projects" => [
+            {
+              "admins" => [
+                {
+                  "default_project" => "demo",
+                  "email" => "jeremiah@example.com",
+                  "name" => "Jeremiah Lee",
+                  "sharer_id" => "9496x4x0-20xx-012x-58xx-123139064x82",
+                  "username" => "jeremiah"
+                }
+              ],
+              "api_key" => "x3x202x0151xxxx207x3xx99xxx3x6xx8x2x1d2xxxx5xx72899986xxxx1080x6",
+              "created_at" => "2010-04-02 23:15:59",
+              "default_domain" => "demo.awe.sm",
+              "domains" => [
+                "demo.awe.sm"
+              ],
+              "name" => "demo",
+              "sharers" => [
+                {
+                  "default_project" => "bunyan_logging",
+                  "email" => "paul@example.com",
+                  "name" => "Paul Bunyan",
+                  "sharer_id" => "8x58x4x0-39x5-012x-8109-123139064x82",
+                  "username" => "pbunyan"
+                }
+              ],
+              "updated_at" => "2011-07-21 18:28:16",
+              "viewers" => [
+                {
+                  "default_project" => "appleseeds_blog",
+                  "email" => "jonny@example.com",
+                  "name" => "Jonny Appleseed",
+                  "sharer_id" => "9x69x9x0-42x1-420x-9876-123139064x99",
+                  "username" => "jonny"
+                }
+              ]
+            }
+          ]
+        }
+      }.to_json
+    end
+
+    let(:json_error_response) do
+      {
+        "request" => {
+          "action" => "list", 
+          "subscription_key" => "butt", 
+          "application_key" => "tlVC3D", 
+          "controller" => "project" 
+        },
+        "error" => "Invalid subscription key"
+      }.to_json
+    end
+
+    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' })
+      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' })
+    end
+
+    it 'posts to the awe.sm project list api properly' do
+      Awesm::Project.list
+
+      a_request(:post, "http://api.awe.sm/projects/list").
+        with(:query => {:subscription_key => "sub-xxxxxx", :application_key => "app-xxxxxx"}).
+        should have_been_made.once
+    end
+
+    context 'when an error occurs' do
+      before { Awesm.subscription_key = 'invalid' }
+      it 'returns nil' do
+        project = Awesm::Project.list
+        project.should == nil
+      end
+    end
+
+    context 'when successful' do
+      it 'returns an array of Awesm:Project objects' do
+        projects = Awesm::Project.list
+        projects.first.should be_an_instance_of(Awesm::Project)
+      end
+    end
+  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' })
+    end
+
     it 'returns the awe.sm api_key' do
       project = Awesm::Project.create({ :name => "TotallyAwesomeProject" })
       project.api_key.should == '6xxxxxxxxx58xx0xxx74xx3x76xx83x6x34xx48x7xxxx55x167037818d65x66x'

data/spec/awesm/url_spec.rb

@@ -2,7 +2,17 @@ require 'spec_helper'
 
 describe Awesm::Url do
   describe '.share' do
-    it 'returns the correct awe.sm url' do
+    let(:required_parameters) do
+      {
+        :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'
+      }
+    end
+
+    it 'returns the correct awe.sm url when passed the required parameters' do
       Awesm::Url.share(:url => 'http://developers.awe.sm/',
                        :key => '5c8b1a212434c2153c2f2c2f2c765a36140add243bf6eae876345f8fd11045d9',
                        :tool => 'mKU7uN',
@@ -11,9 +21,38 @@ describe Awesm::Url do
         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'
     end
 
-    it 'returns nil if no options are sent in' do
+    it 'returns nil if it receives an empty hash' do
       Awesm::Url.share({}).should == nil
     end
+
+    it 'returns nil if it receives nothing' do
+      Awesm::Url.share.should == nil
+    end
+
+    [[: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 awe.sm url when also passed a '#{option.to_s}' parameter" do
+        Awesm::Url.share(required_parameters.merge(option => value)).
+          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&#{option.to_s}=#{value}"
+      end
+    end
+
+    it "accepts user_id related parameters" do
+      url = Awesm::Url.share(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/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"
+    end
+
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: awesm
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Sathya Sekaran
@@ -19,8 +19,8 @@ cert_chain: []
 date: 2011-12-08 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"
-  type: :development
+  name: rake
   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"
-  type: :development
+  name: rspec
   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"
-  type: :development
+  name: webmock
   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"
-  type: :development
+  name: httparty
   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"
-  type: :development
+  name: json
   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"
-  type: :development
+  name: hashie
   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"
-  type: :development
+  name: ruby-debug
   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"
-  type: :runtime
+  name: httparty
   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"
-  type: :runtime
+  name: json
   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"
-  type: :runtime
+  name: hashie
   version_requirements: *id010
 description: The 'awesm' gem is an interface for awe.sm (http://totally.awe.sm), a social link analytics tracking service.
 email: 
@@ -215,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: awesm
-rubygems_version: 1.8.12
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Totally awe.sm!