mbsy 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,49 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    mbsy (1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
+    factory_girl (2.1.2)
+      activesupport
+    faker (1.0.1)
+      i18n (~> 0.4)
+    fakeweb (1.3.0)
+    httparty (0.8.3)
+      multi_json (~> 1.0)
+      multi_xml
+    i18n (0.6.0)
+    json (1.7.3)
+    multi_json (1.3.6)
+    multi_xml (0.5.1)
+    rake (0.9.2.2)
+    rb-fsevent (0.4.3.1)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.1.1)
+  factory_girl (~> 2.1.0)
+  faker (~> 1.0.1)
+  fakeweb (~> 1.3.0)
+  httparty (~> 0.8.3)
+  json
+  mbsy!
+  rake (~> 0.9.2)
+  rb-fsevent (~> 0.4.2)
+  rspec (~> 2.7.0)
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Tom Mullen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# mbsy
+
+Ambassador API wrapper for Ruby.
+
+This is a lightweight Ruby wrapper for the [Ambassador](http://getambassador.com) API.
+
+### Installation
+
+This library can be installed as a gem. It is hosted on [Rubygems](http://rubygems.org).
+
+You can install this library as a gem using the following command:
+
+$ gem install mbsy
+
+### Usage
+
+Simply require this library before you use it:
+
+```ruby
+require 'mbsy'
+```
+
+If you're using Rails 3.x, you could include this gem in your Gemfile.
+
+```ruby
+gem 'mbsy'
+```
+
+Install the gem using the following command:
+$ bundle install
+
+If you're using Rails 2 you could include this gem in your configuration, i.e. in `environment.rb`
+
+```ruby
+config.gem 'mbsy'
+```
+### Initialise
+
+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'
+end
+```
+
+The mbsy gem will give you access to classes such as:
+
+* `Mbsy::Company`  
+* `Mbsy::Ambassador`  
+* `Mbsy::Shortcode`
+
+### 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.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* 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.
+* 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
+
+Finish of test suite.
+
+### Copyright
+
+Copyright (c) 2012 Tom Mullen. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,4 @@
+# encoding: utf-8
+require 'bundler'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')

data/lib/mbsy/resources/ambassador.rb

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

data/lib/mbsy/resources/balance.rb

@@ -0,0 +1,16 @@
+module Mbsy
+  class Balance < Base
+    
+    def self.update(mode, params={})
+      raise ArgumentError, "You must include :email" unless params[:email]
+      raise ArgumentError, "You must include :amount" unless params[:amount]
+      case mode
+      when :add
+        call('add', params)
+      when :deduct
+        call('deduct', params)
+      end
+    end
+    
+  end
+end

data/lib/mbsy/resources/base.rb

@@ -0,0 +1,24 @@
+module Mbsy
+  class Base
+    include HTTParty
+    format :json
+    default_timeout 30
+    default_params :output => 'json'
+    
+    def self.element_name
+      name.split(/::/).last.underscore
+    end
+ 
+    def self.call(method, params = {})
+      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"]})"
+      end
+
+      response['data']
+    end
+  end
+end

data/lib/mbsy/resources/company.rb

@@ -0,0 +1,13 @@
+module Mbsy
+  class Company < Base
+        
+    def self.get_details
+      call('get')
+    end
+    
+    def self.stats
+      call('stats')
+    end
+    
+  end
+end

data/lib/mbsy/resources/event.rb

@@ -0,0 +1,11 @@
+module Mbsy
+  class Event < Base
+    
+    def self.create(params={})
+      raise ArgumentError, "You must include :campaign_uid" unless params[:campaign_uid]
+      raise ArgumentError, "You must include :email" unless params[:email]
+      call('record', params)
+    end
+    
+  end
+end

data/lib/mbsy/resources/shortcode.rb

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

data/lib/mbsy/resources/social.rb

@@ -0,0 +1,10 @@
+module Mbsy
+  class Social < Base
+    
+    def self.find(params={})
+      raise ArgumentError, "You must include :email" unless params[:email]
+      call('addthis', params)
+    end
+    
+  end
+end

data/lib/mbsy.rb

@@ -0,0 +1,21 @@
+require 'httparty'
+require 'json'
+require 'mbsy/resources/base'
+require 'mbsy/resources/ambassador'
+require 'mbsy/resources/balance'
+require 'mbsy/resources/company'
+require 'mbsy/resources/event'
+require 'mbsy/resources/shortcode'
+require 'mbsy/resources/social'
+
+module Mbsy
+  class << self
+    attr_accessor :api_key, :user_name
+    def configure
+      yield self
+      def self.site_uri
+        "https://getambassador.com/api/v2/#{user_name}/#{api_key}/json/"
+      end
+    end
+  end
+end

data/mbsy.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name    = 'mbsy'
+  s.version = '1.0.0'
+  s.date    = '2012-06-10'
+  s.summary = 'A Ruby wrapper for Ambassador API'
+  s.description = ''
+  s.author = 'Tom Mullen'
+  s.email = 'tom@zappdrewards.com'
+  s.homepage = 'http://github.com/temullen/mbsy'
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = ">= 1.9.2"
+
+  s.add_development_dependency('rake', '~> 0.9.2')
+  s.add_development_dependency('rspec', '~> 2.7.0')
+  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("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

data/spec/ambassador_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+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') }
+
+  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')
+      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)
+    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
+  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)
+  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)
+  end
+   
+end

data/spec/base_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Mbsy::Base do
+  
+  it 'parses element names' do
+    Mbsy::Base.stub!(:name).and_return("Test::Namespace::ElementName")
+    Mbsy::Base.element_name.should eql('element_name')
+  end
+
+end

data/spec/mbsy_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Mbsy do
+  context 'configuration setup' do
+  
+    it "builds the url correctly" do
+      expect {
+        Mbsy.configure do |c|
+          c.api_key = "API-123"
+          c.user_name = "tester"
+        end
+      }.to change { Mbsy.site_uri.to_s }.to("https://getambassador.com/api/v2/tester/API-123/json/")
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'mbsy'
+require 'rspec'
+require 'fakeweb'
+require 'factory_girl'
+require 'faker'
+require 'factories'
+
+FakeWeb.allow_net_connect = false
+
+Mbsy.configure do |c|
+  c.api_key = 'test'
+  c.user_name = 'test'
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end
+
+def fake_domain
+  "https://#{Mbsy.site_uri}/"
+end

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: mbsy
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Tom Mullen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+description: ''
+email: tom@zappdrewards.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mbsy.rb
+- lib/mbsy/resources/.DS_Store
+- lib/mbsy/resources/ambassador.rb
+- lib/mbsy/resources/balance.rb
+- lib/mbsy/resources/base.rb
+- lib/mbsy/resources/company.rb
+- lib/mbsy/resources/event.rb
+- lib/mbsy/resources/shortcode.rb
+- lib/mbsy/resources/social.rb
+- mbsy.gemspec
+- spec/ambassador_spec.rb
+- spec/base_spec.rb
+- spec/factories.rb
+- spec/mbsy_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/temullen/mbsy
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper for Ambassador API
+test_files: []