awesm 0.0.1 → 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    awesm (0.0.1)
+    awesm (0.1.0)
+      hashie
       httparty
       json
 
@@ -9,15 +10,20 @@ GEM
   remote: http://rubygems.org/
   specs:
     addressable (2.2.6)
+    columnize (0.3.4)
     crack (0.3.1)
     diff-lcs (1.1.3)
+    hashie (0.2.2)
     httparty (0.8.1)
       multi_json
       multi_xml
     json (1.6.1)
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
     multi_json (1.0.3)
     multi_xml (0.4.1)
     rake (0.9.2.2)
+    rbx-require-relative (0.0.5)
     rspec (2.7.0)
       rspec-core (~> 2.7.0)
       rspec-expectations (~> 2.7.0)
@@ -26,6 +32,11 @@ GEM
     rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.7.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
     webmock (1.7.7)
       addressable (> 2.2.5, ~> 2.2)
       crack (>= 0.1.7)
@@ -35,8 +46,10 @@ PLATFORMS
 
 DEPENDENCIES
   awesm!
+  hashie
   httparty
   json
   rake
   rspec
+  ruby-debug
   webmock

data/README.md

@@ -0,0 +1,30 @@
+= Awesm =
+
+The *awesm* gem is an easy way to access the awe.sm API (http://totally.awe.sm).
+
+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 :)
+
+== Usage ==
+
+```ruby
+Awesm.subscription_key = 'sub-xxxxxx'
+project = Awesm::Project.create(:name => 'Totally Awe.sm!')
+project.api_key # => '1234567890abcdefghijklmnopqrstuvwxyz'
+```
+
+== Contributing ==
+
+* fork
+* clone
+* bundle install
+* bundle exec rspec spec
+* commit code with passing specs
+* push to a topic branch
+* send us a pull request :)
+
+== Manitainers ==
+
+* *Sathya Sekaran*
+* *Michael Durnhofer*

data/awesm.gemspec

@@ -23,7 +23,10 @@ Gem::Specification.new do |s|
   s.add_development_dependency "webmock"
   s.add_development_dependency "httparty"
   s.add_development_dependency "json"
+  s.add_development_dependency "hashie"
+  s.add_development_dependency "ruby-debug"
 
   s.add_runtime_dependency "httparty"
   s.add_runtime_dependency "json"
+  s.add_runtime_dependency "hashie"
 end

data/lib/awesm.rb

@@ -2,16 +2,24 @@ require 'awesm/version'
 
 require 'httparty'
 require 'json'
+require 'hashie'
 
 module Awesm
-  class Project
+  def self.subscription_key=(key)
+    @@subscription_key = key
+  end
+
+  def self.subscription_key
+    @@subscription_key
+  end
+
+  class Project < Hashie::Mash
     include HTTParty
-    base_uri "http://api.awe.sm/projects"
+    base_uri 'http://api.awe.sm/projects'
 
-    def initialize(attributes)
-      self.class.post("/new", :query => { :subscription_key => attributes[:subscription_key], :json => { :name => attributes[:name] }.to_json })
+    def self.create(attributes)
+      response = post('/new', :query => { :subscription_key => Awesm.subscription_key, :json => attributes.to_json })
+      new(response['response']['project'])
     end
   end
 end
-
-

data/lib/awesm/version.rb

@@ -1,3 +1,3 @@
 module Awesm
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/awesm_spec.rb

@@ -1,20 +1,67 @@
 require 'spec_helper'
 
+describe Awesm do
+  describe '.subscription_key=' do
+    it 'sets the subscription key' do
+      Awesm.subscription_key = '1234567890abcdef1234567890abcdef'
+      Awesm.subscription_key.should == '1234567890abcdef1234567890abcdef'
+    end
+  end
+
+  after(:each) { Awesm.subscription_key = nil }
+end
+
 describe Awesm::Project do
-  context '.new' do
+  let(:json_response) do 
+    {
+      "request" => {
+        "json" => "{\"name\" =>\"Totally Awesome Project\"}",
+        "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" => "myNewProject",
+          "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:%22Totally%20Awesome%20Project%22%7D&subscription_key=sub-xxxxxx").
-         to_return(:status => 200, :body => "", :headers => {})
-    end
+  before do
+    Awesm.subscription_key = 'sub-xxxxxx'
+    stub_request(:post, "http://api.awe.sm/projects/new?json=%7B%22name%22:%22Totally%20Awesome%20Project%22%7D&subscription_key=sub-xxxxxx").
+       to_return(:status => 200, :body => json_response, :headers => { 'Content-Type' => 'application/json;charset=utf-8' })
+  end
+  after { Awesm.subscription_key = nil }
 
-    it 'creates a project' do
-      Awesm::Project.new(:subscription_key => "sub-xxxxxx", :name => "Totally Awesome Project").should be_an_instance_of(Awesm::Project)
+  context '.create' do
+    it 'returns an Awesm::Project' do
+      project = Awesm::Project.create(:name => "Totally Awesome Project")
+      project.should be_an_instance_of(Awesm::Project)
     end
 
     it 'posts to the awe.sm project creation api properly' do
-      Awesm::Project.new({ :subscription_key => "sub-xxxxxx", :name => "Totally Awesome Project" })
-      a_request(:post, "http://api.awe.sm/projects/new").with(:query => {:subscription_key => "sub-xxxxxx", :json => { "name" => "Totally Awesome Project" }.to_json }).should have_been_made.once
+      Awesm::Project.create({ :name => "Totally Awesome Project" })
+
+      a_request(:post, "http://api.awe.sm/projects/new").
+        with(:query => {:subscription_key => "sub-xxxxxx", :json => { "name" => "Totally Awesome Project" }.to_json }).
+        should have_been_made.once
+    end
+  end
+
+  describe '#api_key' do
+    it 'returns the awe.sm api_key' do
+      project = Awesm::Project.create({ :name => "Totally Awesome Project" })
+      project.api_key.should == '6xxxxxxxxx58xx0xxx74xx3x76xx83x6x34xx48x7xxxx55x167037818d65x66x'
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 Bundler.setup
 
+require 'ruby-debug'
 require 'webmock/rspec'
 
 require 'awesm'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: awesm
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Sathya Sekaran
@@ -90,7 +90,7 @@ dependencies:
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  type: :runtime
+  type: :development
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -100,11 +100,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: httparty
+  name: hashie
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  type: :runtime
+  type: :development
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -114,8 +114,50 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: json
+  name: ruby-debug
   version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: httparty
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: json
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  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: 
 - sfsekaran@gmail.com
@@ -127,10 +169,11 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
 - .rspec
 - Gemfile
 - Gemfile.lock
-- README
+- README.md
 - Rakefile
 - awesm.gemspec
 - lib/awesm.rb