mailup 1.1.0

data/spec/mailup/console/import_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe MailUp::Console::Import do
+  before(:each) { init_mailup }
+
+  %w(status).each do |method|
+    it "should have a #{method} method" do
+      @mailup.console.import(1).should respond_to(method.to_sym)
+    end
+  end
+
+  it "should fire the correct GET request for status" do
+    id = rand(100).abs
+    @mailup.console.import(id).api.should_receive(:get).with("#{@mailup.console.import(id).api.path}/Import/#{id}")
+    @mailup.console.import(id).status
+  end
+end

data/spec/mailup/console/list_spec.rb

@@ -0,0 +1,164 @@
+require 'spec_helper'
+
+describe MailUp::Console::List do
+  before(:each) { init_mailup }
+
+  %w(groups add_group update_group delete_group recipient_groups pending subscribed unsubscribed import_recipients subscribe unsubscribe tags add_tag update_tag delete_tag attachments add_attachment delete_attachment images add_image add_message_from_template add_message update_message update_message_visibility delete_message message_details emails online_emails archived_emails send_history send_message templates template_details).each do |method|
+    it "should have a #{method} method" do
+      @mailup.console.list(1).should respond_to(method.to_sym)
+    end
+  end
+
+  # GET requests
+
+  %w(groups tags images emails templates).each do |method|
+    it "should fire the correct GET request for #{method}" do
+      @mailup.console.list(1).api.should_receive(:get).with("#{@mailup.console.list(1).api.path}/List/1/#{method.capitalize}", {params: {}})
+      @mailup.console.list(1).send(method.to_sym)
+    end
+  end
+
+  %w(pending subscribed unsubscribed).each do |method|
+    it "should fire the correct GET request for #{method}" do
+      @mailup.console.list(1).api.should_receive(:get).with("#{@mailup.console.list(1).api.path}/List/1/Recipients/#{method.capitalize}", {params: {}})
+      @mailup.console.list(1).send(method.to_sym)
+    end
+  end
+
+  %w(online_emails archived_emails).each do |method|
+    it "should fire the correct GET request for #{method}" do
+      @mailup.console.list(1).api.should_receive(:get).with("#{@mailup.console.list(1).api.path}/List/1/#{method.split('_').first.capitalize}/Emails", {params: {}})
+      @mailup.console.list(1).send(method.to_sym)
+    end
+  end
+
+  it "should fire the correct GET request for recipient_groups" do
+    @mailup.console.list(1).api.should_receive(:get).with("#{@mailup.console.list(1).api.path}/List/1/Recipient/2/Groups", {params: {}})
+    @mailup.console.list(1).recipient_groups(2)
+  end
+
+  it "should fire the correct GET request for attachments" do
+    @mailup.console.list(1).api.should_receive(:get).with("#{@mailup.console.list(1).api.path}/List/1/Email/2/Attachment", {params: {}})
+    @mailup.console.list(1).attachments(2)
+  end
+
+  it "should fire the correct GET request for message_details" do
+    @mailup.console.list(1).api.should_receive(:get).with("#{@mailup.console.list(1).api.path}/List/1/Email/2")
+    @mailup.console.list(1).message_details(2)
+  end
+
+  it "should fire the correct GET request for send_history" do
+    @mailup.console.list(1).api.should_receive(:get).with("#{@mailup.console.list(1).api.path}/List/1/Email/2/SendHistory", {params: {}})
+    @mailup.console.list(1).send_history(2)
+  end
+
+  it "should fire the correct GET request for template_details" do
+    @mailup.console.list(1).api.should_receive(:get).with("#{@mailup.console.list(1).api.path}/List/1/Templates/2")
+    @mailup.console.list(1).template_details(2)
+  end
+
+  # POST requests
+
+  %w(add_group import_recipients).each do |method|
+    it "should fire the correct POST request for #{method}" do
+      payload = Date._jisx0301("empty hash, please")
+      @mailup.console.list(1).api.should_receive(:post).with("#{@mailup.console.list(1).api.path}/List/1/#{method.split('_').last.capitalize}", {body: payload})
+      @mailup.console.list(1).send(method.to_sym, payload)
+    end
+  end
+
+  it "should fire the correct POST request for subscribe" do
+    payload = rand(100).abs
+    @mailup.console.list(1).api.should_receive(:post).with("#{@mailup.console.list(1).api.path}/List/1/Subscribe/#{payload}")
+    @mailup.console.list(1).subscribe(payload)
+  end
+
+  it "should fire the correct POST request for add_tag" do
+    payload = "Tag Name"
+    @mailup.console.list(1).api.should_receive(:post).with("#{@mailup.console.list(1).api.path}/List/1/Tag", {body: payload})
+    @mailup.console.list(1).add_tag(payload)
+  end
+
+  it "should fire the correct POST request for add_attachment" do
+    message = slot = rand(100).abs
+    payload = Date._jisx0301("empty hash, please")
+    @mailup.console.list(1).api.should_receive(:post).with("#{@mailup.console.list(1).api.path}/List/1/Email/#{message}/Attachment/#{slot}", {body: payload})
+    @mailup.console.list(1).add_attachment(message, slot, payload)
+  end
+
+  it "should fire the correct POST request for add_image" do
+    payload = Date._jisx0301("empty hash, please")
+    @mailup.console.list(1).api.should_receive(:post).with("#{@mailup.console.list(1).api.path}/List/1/Images", {body: payload})
+    @mailup.console.list(1).add_image(payload)
+  end
+
+  it "should fire the correct POST request for add_message_from_template" do
+    payload = rand(100).abs
+    @mailup.console.list(1).api.should_receive(:post).with("#{@mailup.console.list(1).api.path}/List/1/Email/Template/#{payload}")
+    @mailup.console.list(1).add_message_from_template(payload)
+  end
+
+  it "should fire the correct POST request for add_message" do
+    payload = Date._jisx0301("empty hash, please")
+    @mailup.console.list(1).api.should_receive(:post).with("#{@mailup.console.list(1).api.path}/List/1/Email", {body: payload})
+    @mailup.console.list(1).add_message(payload)
+  end
+
+  it "should fire the correct POST request for send_message" do
+    payload = rand(100).abs
+    @mailup.console.list(1).api.should_receive(:post).with("#{@mailup.console.list(1).api.path}/List/1/Email/#{payload}/Send")
+    @mailup.console.list(1).send_message(payload)
+  end
+
+  # PUT requests
+
+  it "should fire the correct PUT request for update_group" do
+    id = rand(100).abs
+    payload = Date._jisx0301("empty hash, please")
+    @mailup.console.list(1).api.should_receive(:put).with("#{@mailup.console.list(1).api.path}/List/1/Group/#{id}", {body: payload})
+    @mailup.console.list(1).update_group(id, payload)
+  end
+
+  it "should fire the correct PUT request for update_tag" do
+    id = rand(100).abs
+    payload = Date._jisx0301("empty hash, please")
+    @mailup.console.list(1).api.should_receive(:put).with("#{@mailup.console.list(1).api.path}/List/1/Tag/#{id}", {body: payload})
+    @mailup.console.list(1).update_tag(id, payload)
+  end
+
+  it "should fire the correct PUT request for update_message" do
+    id = rand(100).abs
+    payload = Date._jisx0301("empty hash, please")
+    @mailup.console.list(1).api.should_receive(:put).with("#{@mailup.console.list(1).api.path}/List/1/Email/#{id}", {body: payload})
+    @mailup.console.list(1).update_message(id, payload)
+  end
+
+  it "should fire the correct PUT request for update_message_visibility" do
+    id = rand(100).abs
+    @mailup.console.list(1).api.should_receive(:put).with("#{@mailup.console.list(1).api.path}/List/1/Email/#{id}/Online/Visibility", {body: true})
+    @mailup.console.list(1).update_message_visibility(id, true)
+  end
+
+  # DELETE requests
+
+  %w(delete_group unsubscribe delete_tag).each do |method|
+    it "should fire the correct DELETE request for #{method}" do
+      id = rand(100).abs
+      @mailup.console.list(1).api.should_receive(:delete).with("#{@mailup.console.list(1).api.path}/List/1/#{method.split('_').last.capitalize}/#{id}")
+      @mailup.console.list(1).send(method.to_sym, id)
+    end
+  end
+
+  it "should fire the correct DELETE request for delete_attachment" do
+    id = slot = rand(100).abs
+    @mailup.console.list(1).api.should_receive(:delete).with("#{@mailup.console.list(1).api.path}/List/1/Email/#{id}/#{slot}")
+    @mailup.console.list(1).delete_attachment(id, slot)
+  end
+
+  it "should fire the correct DELETE request for delete_message" do
+    id = slot = rand(100).abs
+    @mailup.console.list(1).api.should_receive(:delete).with("#{@mailup.console.list(1).api.path}/List/1/Email/#{id}")
+    @mailup.console.list(1).delete_message(id)
+  end
+
+end

data/spec/mailup/console/recipient_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe MailUp::Console::Recipient do
+  before(:each) { init_mailup }
+
+  %w(update fields).each do |method|
+    it "should have a #{method} method" do
+      @mailup.console.recipient.should respond_to(method.to_sym)
+    end
+  end
+end

data/spec/mailup/console/user_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe MailUp::Console::User do
+  before(:each) { init_mailup }
+
+  %w(emails lists).each do |method|
+    it "should have a #{method} method" do
+      @mailup.console.user.should respond_to(method.to_sym)
+    end
+
+    it "should fire the correct GET request for #{method}" do
+      @mailup.console.user.api.should_receive(:get).with("#{@mailup.console.user.api.path}/User/#{method.capitalize}", {params: {}})
+      @mailup.console.user.send(method.to_sym)
+    end
+  end
+end

data/spec/mailup/mailup_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe MailUp::API do
+  context 'initialization' do
+    # Make sure a hash is provided
+    it 'requires credentials' do
+      expect{ MailUp::API.new }.to raise_error(MailUp::Error, 'MailUp credentials missing')
+    end
+
+    # Validate the credentials hash keys
+    [:client_id, :client_secret, :oauth].each do |key|
+      it "requires credentials to have a '#{key}' key" do
+        @credentials.delete_if{ |k,v| k == key }
+        expect{ MailUp::API.new(@credentials) }.to raise_error(MailUp::Error, "MailUp credentials must include a #{key} key")
+      end
+    end
+
+    # Make sure the oauth key is a hash
+    it 'requires credentials to have an oauth hash' do
+      @credentials[:oauth] = nil
+      expect{ MailUp::API.new(@credentials).merge!(token: true) }.to raise_error(MailUp::Error, "MailUp credentials :oauth must be a hash")
+    end
+
+    # Validate the oauth hash keys
+    [:token, :refresh_token, :expires_at].each do |key|
+      it "requires credentials with an oauth hash containing a '#{key}' key" do
+        @credentials[:oauth].delete_if{ |k,v| k == key }
+        expect{ MailUp::API.new(@credentials) }.to raise_error(MailUp::Error, "MailUp credentials :oauth hash must include a #{key} key")
+      end
+    end 
+  end
+
+  # Add a context for sending a request
+  # Verify that each verb method sends the right message.
+  # Verify that the objects exist.
+end

data/spec/mailup/public/base_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe MailUp::Public do
+  before(:each){ init_mailup }
+
+  it 'should return a public base object' do
+    @mailup.public.should be_an_instance_of(MailUp::Public::Base)
+  end
+
+  it 'should have the correct API path' do
+    @mailup.public.api.path.should eq("/API/v#{MailUp::API_VERSION}/Rest/PublicService.svc")
+  end
+
+  %w(console).each do |resource|
+    context resource do
+      it "should return a #{resource} object" do
+        test = @mailup.public.send(resource.to_sym)
+        test.should be_an_instance_of(Object.const_get "MailUp::Public::#{resource.capitalize}")
+      end
+    end
+  end
+end

data/spec/mailup/public/console_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe MailUp::Public::Console do
+  before(:each) { init_mailup }
+
+  %w(new status).each do |method|
+    it "should have a #{method} method" do
+      @mailup.public.console.should respond_to(method.to_sym)
+    end
+  end
+
+  it "should fire the correct POST request for new" do
+    payload = Date._jisx0301("empty hash, please")
+    @mailup.public.console.api.should_receive(:post).with("#{@mailup.public.console.api.path}/Console/TrialActivation", {body: payload})
+    @mailup.public.console.new(payload)
+  end
+
+  it "should fire the correct POST request for status" do
+    payload = Date._jisx0301("empty hash, please")
+    @mailup.public.console.api.should_receive(:post).with("#{@mailup.public.console.api.path}/Console/TrialActivationStatus", {body: payload})
+    @mailup.public.console.status(payload)
+  end
+
+end

data/spec/mailup/stats/base_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe MailUp::Stats do
+  before(:each){ init_mailup }
+
+  it 'should return a stats base object' do
+    @mailup.stats.should be_an_instance_of(MailUp::Stats::Base)
+  end
+
+  it 'should have the correct API path' do
+    @mailup.stats.api.path.should eq("/API/v#{MailUp::API_VERSION}/Rest/MailStatisticsService.svc")
+  end
+
+  %w(message recipient).each do |resource|
+    context resource do
+      it "should return a #{resource} object" do
+        test = @mailup.stats.send(resource.to_sym, 1)
+        test.should be_an_instance_of(Object.const_get "MailUp::Stats::#{resource.capitalize}")
+      end
+    end
+  end
+end

data/spec/mailup/stats/message_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+# Stats::Message Methods
+describe MailUp::Stats::Message do
+  before(:each){ init_mailup }
+
+  %w(recipients recipients_count views views_count bounces bounces_count unsubscribes unsubscribes_count clicks clicks_count url_clicks url_clicks_count).each do |method|
+    it "should have a #{method} method" do
+      @mailup.stats.message(1).should respond_to(method.to_sym)
+    end
+  end
+
+  # List methods
+
+  %w(recipients views bounces clicks url_clicks).each do |method|
+    it "should fire the correct GET request for #{method}" do
+      @mailup.stats.message(1).api.should_receive(:get).with("#{@mailup.stats.message(1).api.path}/Message/1/List/#{method.split('_').collect(&:capitalize).join}", {params: {}})
+      @mailup.stats.message(1).send(method.to_sym)
+    end
+  end
+
+  # Count methods
+
+  %w(recipients_count views_count bounces_count clicks_count).each do |method|
+    it "should fire the correct GET request for #{method}" do
+      @mailup.stats.message(1).api.should_receive(:get).with("#{@mailup.stats.message(1).api.path}/Message/1/Count/#{method.split('_').first.capitalize}")
+      @mailup.stats.message(1).send(method.to_sym)
+    end
+  end
+
+  it "should fire the correct GET request for url_clicks_count" do
+    @mailup.stats.message(1).api.should_receive(:get).with("#{@mailup.stats.message(1).api.path}/Message/1/Count/UrlClicks")
+    @mailup.stats.message(1).url_clicks_count
+  end
+end

data/spec/mailup/stats/recipient_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+# Stats::Recipient Methods
+describe MailUp::Stats::Recipient do
+  before(:each) { init_mailup }
+
+  %w(deliveries deliveries_count views views_count bounces_details bounces bounces_count unsubscribes unsubscribes_count clicks_details clicks clicks_count).each do |method|
+    it "should have a #{method} method" do
+      @mailup.stats.recipient(1).should respond_to(method.to_sym)
+    end
+  end
+
+  # List methods
+
+  %w(deliveries views bounces_details bounces clicks_details clicks).each do |method|
+    it "should fire the correct GET request for #{method}" do
+      @mailup.stats.recipient(1).api.should_receive(:get).with("#{@mailup.stats.recipient(1).api.path}/Recipient/1/List/#{method.split('_').collect(&:capitalize).join}", {params: {}})
+      @mailup.stats.recipient(1).send(method.to_sym)
+    end
+  end
+
+  it "should fire the correct GET request for unsubscribes" do
+    @mailup.stats.recipient(1).api.should_receive(:get).with("#{@mailup.stats.recipient(1).api.path}/Recipient/1/List/Unsubscriptions", {params: {}})
+    @mailup.stats.recipient(1).unsubscribes
+  end
+
+  # Count methods
+
+  %w(deliveries_count views_count bounces_count clicks_count).each do |method|
+    it "should fire the correct GET request for #{method}" do
+      @mailup.stats.recipient(1).api.should_receive(:get).with("#{@mailup.stats.recipient(1).api.path}/Recipient/1/Count/#{method.split('_').first.capitalize}")
+      @mailup.stats.recipient(1).send(method.to_sym)
+    end
+  end
+
+  it "should fire the correct GET request for unsubscribes_count" do
+    @mailup.stats.recipient(1).api.should_receive(:get).with("#{@mailup.stats.recipient(1).api.path}/Recipient/1/Count/Unsubscriptions")
+    @mailup.stats.recipient(1).unsubscribes_count
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'mailup'
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+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
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  # Global hooks
+  config.before(:each) { init_credentials}
+end
+
+# Create Credentials Hash
+def init_credentials
+  @credentials = {
+    client_id: "1234",
+    client_secret: "1234",
+    oauth: {
+      token: "123",
+      refresh_token: "123",
+      expires_at: 123
+    }
+  }
+end
+
+# Create MailUp Object
+def init_mailup
+  @mailup = MailUp::API.new(@credentials)
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: mailup
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Brian Getting
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby gem for interacting with the MailUp REST API.
+email:
+- brian@tatem.ae
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mailup.rb
+- lib/mailup/console/base.rb
+- lib/mailup/console/email.rb
+- lib/mailup/console/group.rb
+- lib/mailup/console/images.rb
+- lib/mailup/console/import.rb
+- lib/mailup/console/list.rb
+- lib/mailup/console/recipient.rb
+- lib/mailup/console/user.rb
+- lib/mailup/errors.rb
+- lib/mailup/public/base.rb
+- lib/mailup/public/console.rb
+- lib/mailup/stats/base.rb
+- lib/mailup/stats/message.rb
+- lib/mailup/stats/recipient.rb
+- lib/mailup/version.rb
+- mailup.gemspec
+- rails/init.rb
+- spec/mailup/console/base_spec.rb
+- spec/mailup/console/email_spec.rb
+- spec/mailup/console/group_spec.rb
+- spec/mailup/console/images_spec.rb
+- spec/mailup/console/import_spec.rb
+- spec/mailup/console/list_spec.rb
+- spec/mailup/console/recipient_spec.rb
+- spec/mailup/console/user_spec.rb
+- spec/mailup/mailup_spec.rb
+- spec/mailup/public/base_spec.rb
+- spec/mailup/public/console_spec.rb
+- spec/mailup/stats/base_spec.rb
+- spec/mailup/stats/message_spec.rb
+- spec/mailup/stats/recipient_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mailup/mailup-ruby
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the MailUp REST API
+test_files:
+- spec/mailup/console/base_spec.rb
+- spec/mailup/console/email_spec.rb
+- spec/mailup/console/group_spec.rb
+- spec/mailup/console/images_spec.rb
+- spec/mailup/console/import_spec.rb
+- spec/mailup/console/list_spec.rb
+- spec/mailup/console/recipient_spec.rb
+- spec/mailup/console/user_spec.rb
+- spec/mailup/mailup_spec.rb
+- spec/mailup/public/base_spec.rb
+- spec/mailup/public/console_spec.rb
+- spec/mailup/stats/base_spec.rb
+- spec/mailup/stats/message_spec.rb
+- spec/mailup/stats/recipient_spec.rb
+- spec/spec_helper.rb