mbsy 1.0.1 → 1.0.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mbsy (1.0.0)
+    mbsy (1.0.1)
 
 GEM
   remote: http://rubygems.org/
@@ -9,6 +9,13 @@ GEM
     activesupport (3.2.6)
       i18n (~> 0.6)
       multi_json (~> 1.0)
+    columnize (0.3.6)
+    debugger (1.5.0)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.0)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.0)
     diff-lcs (1.1.3)
     factory_girl (2.1.2)
       activesupport
@@ -23,7 +30,7 @@ GEM
     multi_json (1.3.6)
     multi_xml (0.5.1)
     rake (0.9.2.2)
-    rb-fsevent (0.4.3.1)
+    rb-fsevent (0.9.3)
     rspec (2.7.0)
       rspec-core (~> 2.7.0)
       rspec-expectations (~> 2.7.0)
@@ -43,13 +50,14 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.1.1)
+  debugger
   factory_girl (~> 2.1.0)
   faker (~> 1.0.1)
   fakeweb (~> 1.3.0)
   httparty (~> 0.8.3)
-  json
+  json (~> 1.7.3)
   mbsy!
   rake (~> 0.9.2)
-  rb-fsevent (~> 0.4.2)
+  rb-fsevent (~> 0.9.3)
   rspec (~> 2.7.0)
   shoulda

data/README.md

@@ -6,7 +6,7 @@ This is a lightweight Ruby wrapper for the [Ambassador](http://getambassador.com
 
 ### Installation
 
-This library can be installed as a gem. It is hosted on [Rubygems](http://rubygems.org).
+This library can be installed as a gem. It is hosted on [Rubygems](https://rubygems.org/gems/mbsy).
 
 You can install this library as a gem using the following command:
 
@@ -40,8 +40,8 @@ Make sure you include your api credentials in an initialiser.
 
 ```ruby
 Mbsy.configure do |c|
-	c.api_key 'MY_API_KEY'
-	c.user_name 'MY_USER_NAME'
+	c.api_key = 'MY_API_KEY'
+	c.user_name = 'MY_USER_NAME'
 end
 ```
 
@@ -51,6 +51,39 @@ The mbsy gem will give you access to classes such as:
 * `Mbsy::Ambassador`  
 * `Mbsy::Shortcode`
 
+Some examples:
+
+```ruby
+# Add 50 to user account
+Mbsy::Balance.update(:add,{:email => 'example@example.com', :amount => 50})
+
+# Deduct 25 from user account
+Mbsy::Balance.update(:deduct,{:email => 'example@example.com', :amount => 25})
+
+# Get company details
+Mbsy::Company.get_details
+
+# Register a referral event 
+# Note the email address is the new customer email, not the ambassador
+# Autocreate flag sets whether they are created as a new ambassador or not
+Mbsy::Event.create({:email => 'example@example.com', :short_code => REFERRALSHORTCODE, :campaign_uid =>  YOURCAMPAIGNUID, :auto_create => 0})
+
+# Register a revenue event for an ambassador
+Mbsy::Event.create({:email => 'example@example.com', :short_code => REFERRALSHORTCODE, :revenue => 120, :campaign_uid => YOURCAMPAIGNUID})
+
+# Register a revenue event for an ambassador
+# in this case, the email is for a previously registered referred customer, so no short code is required
+Mbsy::Event.create({:email => 'example@example.com', :revenue => 120, :campaign_uid => YOURCAMPAIGNUID})
+
+# Get the details on a shortcode
+Mbsy::Shortcode.find({ :short_code => YOURCAMPAIGNUID })
+
+# Shortcode in a sandbox campaign
+Mbsy::Shortcode.find({ :short_code => YOURCAMPAIGNUID, :sandbox => 1 })
+
+
+```
+
 ### Contributing to mbsy
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
@@ -58,7 +91,7 @@ The mbsy gem will give you access to classes such as:
 * Fork the project.
 * Start a feature/bugfix branch.
 * Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Make sure to add tests for it. This is important so we don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
 ### To Do

data/lib/mbsy.rb

@@ -5,6 +5,7 @@ require 'mbsy/resources/ambassador'
 require 'mbsy/resources/balance'
 require 'mbsy/resources/company'
 require 'mbsy/resources/event'
+require 'mbsy/resources/group'
 require 'mbsy/resources/shortcode'
 require 'mbsy/resources/social'
 
@@ -18,4 +19,4 @@ module Mbsy
       end
     end
   end
-end
+end

data/lib/mbsy/resources/base.rb

@@ -1,4 +1,6 @@
 module Mbsy
+  class RecordNotFound < Exception; end
+  class BadResponse < Exception; end
   class Base
     include HTTParty
     format :json
@@ -13,9 +15,12 @@ module Mbsy
       api_url = Mbsy.site_uri + self.element_name + '/' + method
       
       response = JSON.parse(self.get(api_url, :query => params).body)['response']
-
-      if response["code"] != '200'
-        raise "Error from Ambassador API: #{response["errors"]["error"]} (code #{response["code"]})"
+      case response['code']
+      when "200" # Nothing to do here...
+      when "404"
+        raise RecordNotFound.new(response["errors"]["error"])
+      else
+        raise BadResponse.new(response: response)
       end
 
       response['data']

data/lib/mbsy/resources/group.rb

@@ -0,0 +1,14 @@
+module Mbsy
+  class Group < Base
+    
+    def self.find(params={})
+      raise ArgumentError, "You must include :group_id" unless params[:group_id]
+      call('get', params)
+    end
+    
+    def self.all(params={})
+      call('all', params)
+    end
+    
+  end
+end

data/mbsy.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name    = 'mbsy'
-  s.version = '1.0.1'
-  s.date    = '2013-02-22'
+  s.version = '1.0.2'
+  s.date    = '2013-03-28'
   s.summary = 'A Ruby wrapper for the Ambassador API'
   s.description = ''
   s.author = 'Tom Mullen, Chase Lee'
@@ -19,9 +19,10 @@ Gem::Specification.new do |s|
   s.add_development_dependency('factory_girl', '~> 2.1.0')
   s.add_development_dependency('fakeweb', '~> 1.3.0')
   s.add_development_dependency('faker', '~> 1.0.1')
-  s.add_development_dependency('rb-fsevent', '~> 0.4.2')
+  s.add_development_dependency('rb-fsevent', '~> 0.9.3')
   s.add_development_dependency("shoulda", ">= 0")
   s.add_development_dependency("bundler", "~> 1.1.1")
   s.add_development_dependency('httparty', '~> 0.8.3')
   s.add_development_dependency('json', '~> 1.7.3')
-end
+  s.add_development_dependency('debugger', '~> 1.5.0')
+end

data/spec/ambassador_spec.rb

@@ -4,40 +4,54 @@ require 'ruby-debug'
 describe Mbsy::Ambassador do
   
   let(:resource_prefix) { "#{fake_domain}/ambassadors" }
-  let(:existing_ambassador) { Mbsy::Ambassador.find(email: 'ambassador@mbsy.co', first_name: 'sigma') }
+  before do
+    @existing_ambassador_response =  Mbsy::Ambassador.find(email: 'ambassador@mbsy.co', first_name: 'sigma')
+  end
 
   context 'find existing ambassador' do
-    before do
-      FakeWeb.register_uri(:get, "#{resource_prefix}/get/", :query => existing_ambassador.attributes)
-    end
-    
-    it 'is an instance of Mbsy::Ambassador' do
-      debugger
-      ambassador = Mbsy::Ambassador.find(email: 'ambassador@mbsy.co')
+    subject { Mbsy::Ambassador.find(email: 'ambassador@mbsy.co') }
+    pending 'is an instance of Mbsy::Ambassador' do
       ambassador.should be_instance_of(Mbsy::Ambassador)
     end
-  
-    it 'finds the correct ambassdor by email' do
-      ambassador = Mbsy::Ambassador.find(email: 'ambassador@mbsy.co')
-      ambassador.email.should eq(existing_ambassador.email)
+    it { should be_instance_of(Hash) }
+    it { should have_key('ambassador') }
+    it { should == @existing_ambassador_response }
+
+    it 'should return an ambassador with the same email' do
+      subject['ambassador']['email'].should == @existing_ambassador_response['ambassador']['email']
     end
-  
-    it 'creates the ambassador if you cannot find one' do
-      ambassador = Mbsy::Ambassador.find(email: 'ambassador@mbsy.co', first_name: 'tester')
-      ambassador.first_name.should eq('tester')
+  end
+  context 'existing ambassador not found' do
+    before do
+      # Stub out creation call since this is hitting a live service
+      FakeWeb.register_uri(:get, "#{resource_prefix}/get/", query: {email: 'new_ambassador@mbsy.co', first_name: 'tester'}, response: File.expand_path('spec/fixtures/ambassador_response_v2.json') )
+    end
+    pending 'creates the ambassador if you cannot find one' do
+      # Need a proper stubbed response before this can work
+      ambassador = Mbsy::Ambassador.find(email: 'new_ambassador@mbsy.co', first_name: 'tester')
+      ambassador['ambassador']['first_name'].should eq('tester')
+    end
+    context 'failed lookup without auto-create' do
+      it "should raise a RecordNotFound error " do
+        lambda{
+          Mbsy::Ambassador.find(email: 'not_found@mbsy.co', auto_create: 0)
+        }.should raise_error(Mbsy::RecordNotFound)
+      end
     end
   end
   
   it 'returns a list of all ambassadors' do
-    FakeWeb.register_uri(:get, "#{resource_prefix}/all/", :query => existing_ambassador.attributes)
-    ambassadors = Mbsy::Ambassador.all
-    ambassadors.should include(existing_ambassador)
+    all_response = Mbsy::Ambassador.all
+    ambassadors = all_response['ambassadors']
+    ambassadors.length.should > 0
+    existing_ambassador_in_response = ambassadors.detect{|a| a['email'] == @existing_ambassador_response['ambassador']['email'] }
+    existing_ambassador_in_response.should_not be_nil
+    existing_ambassador_in_response['first_name'].should == 'sigma'
   end
   
-  it 'returns a list of all ambassadors' do
-    FakeWeb.register_uri(:get, "#{resource_prefix}/stats/", :query => existing_ambassador.attributes)
-    ambassador = Mbsy::Ambassador.find(email: 'ambassador@mbsy.co')
-    ambassador.email.should eq(existing_ambassador.email)
+  it 'returns stats on an existing ambassador' do
+    ambassador = Mbsy::Ambassador.stats(email: 'ambassador@mbsy.co')
+    ambassador['ambassador']['email'].should eq(@existing_ambassador_response['ambassador']['email'])
   end
    
-end
+end

data/spec/spec_helper.rb

@@ -26,5 +26,5 @@ RSpec.configure do |config|
 end
 
 def fake_domain
-  "https://#{Mbsy.site_uri}/"
+  "#{Mbsy.site_uri}/"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mbsy
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-22 00:00:00.000000000 Z
+date: 2013-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -98,7 +98,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.9.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -106,7 +106,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.9.3
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
@@ -171,6 +171,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.7.3
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
 description: ''
 email: support@getambassador.com
 executables: []
@@ -192,6 +208,7 @@ files:
 - lib/mbsy/resources/base.rb
 - lib/mbsy/resources/company.rb
 - lib/mbsy/resources/event.rb
+- lib/mbsy/resources/group.rb
 - lib/mbsy/resources/shortcode.rb
 - lib/mbsy/resources/social.rb
 - mbsy.gemspec