emma-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c343b5b6b7dbe54e1382f838b37c6c5b50bce1e
+  data.tar.gz: 50775b93e195e3c24b27722c2f57a69c5f7b7584
+SHA512:
+  metadata.gz: bfc4fe896e5c5db5fce0b58198a9a8dbc9a0710ab51e51197e03671eacafde5a6c934ffed6d723d72394d8508a97f401d500b2bbac76cf9996a448b024d5dd57
+  data.tar.gz: 367fc8e691315a89bd0f9fb4369997de2e0afff9f05fcf401e3aa5014b2d4a67f182ba837869f963da011484bed7fc36bd2609ac829a6b584904db3fbeb52ba3

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+emmapi-*
+test/fixtures/vcr_cassettes/*
+pkg/*

data/.travis.yml

@@ -0,0 +1,21 @@
+---
+language: ruby
+rvm:
+- 1.9.2
+- 1.9.3
+script:
+- bundle exec rake run_tests
+env:
+  global:
+  - secure: |-
+      UgkY7PDsbBfq3Ukyzb6VIWXY6zd7s8bJMLOkkQ7RK7huwl68jfeYSpLwJ6Rm
+      2qVaYj84YDmSwr6ed6Fk2C+1IviqlN4NkJ0c9JtibHHOVOxBB8Y+dm17DFPp
+      jsIOOUB/NduVNOlIKMCwCiXFEPBTwhiWLFGEkE4HHLk3HnxHaj8=
+  - secure: |-
+      agxJsFr30M/dvbj2+tqBHmklouxk8+PRO+DBJOEWdGBxjJVis0kcDsFCp3sa
+      V0TqnS/+7ExVOjez4b6r9NSNrBmxhQuVYEr1Wsk96CE1B16Y1XsCImvIooxl
+      KPJWYy2szbex7i8ibCkA7w0Yvb8QhmHMLAa3aVtteEOAGULyCr4=
+  - secure: |-
+      jqHIRzqNXdFT/QIksVfMYFSHAiFKOY16hNjyWQr8g7g/DuFAIdjO7zhCqK7H
+      bDQ0RDqw84MNnrCFdctvxE6n4nHO3guM4BYLSAENflXVAugzlve5BTFRZfbz
+      qJ5cboa3VSwZeks/PYoIIwbaFCpVlMulEMRgKl0YjDs/y9RhcYo=

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    emma-ruby (0.0.1)
+      httparty
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.11)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    hashdiff (0.3.6)
+    httparty (0.15.6)
+      multi_xml (>= 0.5.2)
+    i18n (0.8.6)
+    json (2.1.0)
+    multi_json (1.5.0)
+    multi_xml (0.6.0)
+    public_suffix (3.0.0)
+    rake (12.1.0)
+    safe_yaml (1.0.4)
+    shoulda (3.3.2)
+      shoulda-context (~> 1.0.1)
+      shoulda-matchers (~> 1.4.1)
+    shoulda-context (1.0.2)
+    shoulda-matchers (1.4.1)
+      activesupport (>= 3.0.0)
+    vcr (3.0.3)
+    webmock (3.0.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  emma-ruby!
+  rake
+  shoulda
+  vcr
+  webmock
+
+BUNDLED WITH
+   1.13.7

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Emma, Inc.
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dennis Monsewicz
+
+MIT License
+
+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,96 @@
+## Emma API Wrapper (Ruby)
+A Ruby wrapper for Emma's API.
+
+## Running the tests [![Build Status](https://travis-ci.org/myemma/EmmaRuby.png)](https://travis-ci.org/myemma/EmmaRuby)
+Set the following environment values
+
+```bash
+export EMMA_ACCOUNT_ID=123456
+export EMMA_PUBLIC_KEY=6fbfd5e68d3306e51350
+export EMMA_PRIVATE_KEY=53f42aa48e24d44a3362
+```
+
+Run the tests
+
+```
+bundle exec rake run_tests
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'emma'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install emma
+
+## Usage
+
+## Instantiation
+```ruby
+require 'emma'
+em = Emma::Setup.new 'account_id', 'public_key', 'private_key', 'debug_true_or_false'
+```
+
+You can also set environment variables and the Emma Wrapper will use them when you create an instance
+```ruby
+ENV['EMMA_ACCOUNT_ID'] = 'account_id'
+ENV['EMMA_PUBLIC_KEY'] = 'public_key'
+ENV['EMMA_PRIVATE_KEY'] = 'private_key'
+em = Emma::Setup.new
+```
+
+## GET Request
+```ruby
+req = em.my_members
+# Will return a members array
+puts req.inspect
+```
+
+## Pagination
+```ruby
+req = em.my_members count: true
+# Will return a count of all of the members tied to your account
+puts req.inspect
+```
+
+```ruby
+req = em.my_members start: 0, end: 200
+# Will return a members array starting with the specified start param and ending with the specified end param
+puts req.inspect
+```
+
+## POST Request
+```ruby
+req = em.add_member email: "helloworld@gmail.com", fields: { first_name: 'hello', last_name: 'world' }
+# Will return a reference object of the newly added member
+puts req.inspect
+```
+
+## PUT Request
+```ruby
+req = em.update_member 111, status: 'e'
+# Will return true if the member was updated
+puts req.inspect
+``` 
+
+## DELETE Request
+```ruby
+req = em.remove_member 111
+# Will return true if the member was deleted
+puts req.inspect
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+require "bundler/gem_tasks"
+
+task :default => [:run_tests]
+Rake::TestTask.new("run_tests") do |t|
+  t.pattern = 'test/test_*.rb'
+  t.verbose = true
+end

data/emma.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'emma/version'
+
+Gem::Specification.new do |s|
+  s.name          = "emma-ruby"
+  s.version       = Emma::VERSION
+  s.authors       = ["Dennis Monsewicz"]
+  s.email         = ["dennismonsewicz@gmail.com"]
+  s.description   = %q{A simple wrapper for integration with Emma's API'}
+  s.summary       = %q{A simple wrapper for integration with Emma's API}
+  s.homepage      = ""
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.test_files    = `git ls-files -- {test}/*`.split '\n'
+  s.require_paths = ["lib"]
+  
+  s.add_dependency 'httparty'
+  s.add_dependency 'json'
+  
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'shoulda'
+  s.add_development_dependency 'vcr'
+  s.add_development_dependency 'webmock'
+end

data/lib/emma.rb

@@ -0,0 +1,40 @@
+require "emma/version"
+require "emma/client"
+require "emma/configurable"
+
+module Emma
+  class << self
+    def available_categories
+      [:fields, :groups, :mailings, :members, :response, :searches, :triggers, :webhooks]
+    end
+  end
+  
+  class Setup
+    include Emma::Configurable
+    
+    attr_accessor :account_id, :public_key, :private_key, :debug
+    
+    def initialize(account_id = nil, public_key = nil, private_key = nil, debug = false)
+      @account_id = account_id || ENV['EMMA_ACCOUNT_ID']
+      @public_key = public_key || ENV['EMMA_PUBLIC_KEY']
+      @private_key = private_key || ENV['EMMA_PRIVATE_KEY']
+      @debug = debug
+    end
+    
+    # establish connection
+    def client
+      @client = Emma::Client.new(options) unless defined?(@client) && @client.hash == options.hash
+      @client
+    end
+    
+    def respond_to_missing?(method, include_private = false)
+      client.respond_to?(client, include_private)
+    end
+    
+    private
+      def method_missing(method_name, *args)
+        return super unless client.respond_to?(method_name)
+        client.send(method_name, *args)
+      end
+  end
+end

data/lib/emma/api/fields.rb

@@ -0,0 +1,37 @@
+# @see http://api.myemma.com/api/external/fields.html
+
+module Emma
+  module API
+    module Fields
+      # Gets a list of this account’s defined fields.
+      def my_fields(params = {})
+        get("/fields", params)
+      end
+      
+      # Gets the detailed information about a particular field.
+      def get_field_by_id(id, params = {})
+        get("/fields/#{id}", params)
+      end
+      
+      # Create a new field
+      def add_field(params = {})
+        post("/fields", params)
+      end
+      
+      # Delete a field
+      def remove_field(id)
+        delete("/fields/#{id}")
+      end
+      
+      # Clear the member data for the specified field.
+      def remove_member_data_for_field(id)
+        post("/fields/#{id}/clear")
+      end
+      
+      # Updates an existing field.
+      def update_field(id, params = {})
+        put("/fields/#{id}", params)
+      end
+    end
+  end
+end

data/lib/emma/api/groups.rb

@@ -0,0 +1,62 @@
+# @see http://api.myemma.com/api/external/groups.html
+
+module Emma
+  module API
+    module Groups
+      # Get a basic listing of all active member groups for a single account.
+      def my_groups(params = {})
+        get("/groups", params)
+      end
+      
+      # Create one or more new member groups.
+      def add_new_groups(params = {})
+        post("/groups", params)
+      end
+      
+      # Get the detailed information for a single member group.
+      def get_group_by_id(id)
+        get("/groups/#{id}")
+      end
+      
+      # Update information for a single member group.
+      def update_group(id, params = {})
+        put("/groups/#{id}", params)
+      end
+      
+      # Delete a single member group.
+      def remove_group(id)
+        delete("/groups/#{id}")
+      end
+      
+      # Get the members in a single active member group.
+      def group_members(id, params = {})
+        get("/groups/#{id}/members", params)
+      end
+      
+      # Add a list of members to a single active member group.
+      def add_members_to_group(id, params = {})
+        put("/groups/#{id}/members", params)
+      end
+      
+      # Remove members from a single active member group.
+      def remove_members_from_group(id, params = {})
+        put("/groups/#{id}/members/remove", params)
+      end
+      
+      # Remove all members from a single active member group.
+      def remove_all_members_from_group(id, params = {})
+        delete("/groups/#{id}/members", params)
+      end
+      
+      # Remove all members from all active member groups as a background job. The member_status_id parameter must be set.
+      def remove_all_members_from_groups(id, params = {})
+        delete("/groups/#{id}/members/remove", params)
+      end
+      
+      # Copy all the users of one group into another group.
+      def copy_members_to_different_group(from_id, to_id, params = {})
+        put("/groups/#{from_id}/#{to_id}/members/copy", params)
+      end
+    end
+  end
+end

data/lib/emma/api/mailings.rb

@@ -0,0 +1,77 @@
+# @see http://api.myemma.com/api/external/mailings.html
+
+module Emma
+  module API
+    module Mailings
+      # Get information about current mailings.
+      def my_mailings(params = {})
+        get("/mailings", params)
+      end
+      
+      # Get detailed information for one mailing.
+      def get_mailing_by_id(id)
+        get("/mailings/#{id}")
+      end
+      
+      # Get the list of members to whom the given mailing was sent.
+      def get_mailing_members(id)
+        get("/mailings/#{id}/members")
+      end
+      
+      # Gets the personalized message content as sent to a specific member as part of the specified mailing.
+      def get_personalized_member_mailing(id, member_id, params = {})
+        get("/mailings/#{id}/messages/#{member_id}", params)
+      end
+      
+      # Get the groups to which a particular mailing was sent.
+      def get_groups_by_mailing(id, params = {})
+        get("/mailings/#{id}/groups", params)
+      end
+      
+      # Get all searches associated with a sent mailing.
+      def mailing_searches(id, params = {})
+        get("/mailings/#{id}/searches", params)
+      end
+      
+      # Update status of a current mailing
+      def update_mailing(id, params = {})
+        put("/mailings/#{id}", params)
+      end
+      
+      # Sets archived timestamp for a mailing so it is no longer included in mailing_list.
+      def remove_mailing(id)
+        delete("/mailings/#{id}")
+      end
+      
+      # Cancels a mailing that has a current status of pending or paused. All other statuses will result in a 404.
+      def cancel_queued_mailing(id)
+        delete("/mailings/cancel/#{id}")
+      end
+      
+      # Forward a previous message to additional recipients. If these recipients are not already in the audience, they will be added with a status of FORWARDED.
+      def forward_mailing_to_additional_recipients(id, member_id, params = {})
+        post("/forwards/#{id}/#{member_id}", params)
+      end
+      
+      # Send a prior mailing to additional recipients. A new mailing will be created that inherits its content from the original.
+      def send_existing_mailing(id, params = {})
+        post("/mailings/#{id}", params)
+      end
+      
+      # Get heads up email address(es) related to a mailing.
+      def mailing_headsup(id)
+        get("/mailings/#{id}/headsup")
+      end
+      
+      # Validate that a mailing has valid personalization-tag syntax
+      def validate_mailing(params = {})
+        post("/mailings/validate", params)
+      end
+      
+      # Declare the winner of a split test manually. In the event that the test duration has not elapsed, the current stats for each test will be frozen and the content defined in the user declared winner will sent to the remaining members for the mailing. Please note, any messages that are pending for each of the test variations will receive the content assigned to them when the test was initially constructed.
+      def declare_winner_of_split_test(mailing_id, winner_id)
+        post("/mailings/#{mailing_id}/winner/#{winner_id}")
+      end
+    end
+  end
+end