emarsys 0.1.0

data/spec/emarsys/extensions_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Hash do
+
+  context 'extensions on Hash' do
+
+    describe '#stringfy_keys' do
+      it "add stringify_keys method to Hash" do
+        expect(Hash.new).to respond_to(:stringify_keys)
+      end
+
+      it "converts symbol-keys into strings" do
+        hash = {:a => 1, :b => 2}
+        expect(hash.stringify_keys).to eq({'a' => 1, "b" => 2})
+      end
+
+      it "does not touch string-keys" do
+        hash = {:a => 1, 'b' => 2}
+        expect(hash.stringify_keys).to eq({'a' => 1, "b" => 2})
+      end
+    end
+  end
+
+end

data/spec/emarsys/field_mapping_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Emarsys::FieldMapping do
+
+  it "defines constant ATTRBUTES " do
+    Emarsys::FieldMapping::ATTRIBUTES.should be_a(Array)
+  end
+
+  it "defines constant ATTRBUTES as an array if hashes" do
+    Emarsys::FieldMapping::ATTRIBUTES.should be_a(Array)
+    Emarsys::FieldMapping::ATTRIBUTES.map{|elem| elem.should be_a(Hash)}
+  end
+
+end

data/spec/emarsys/params_converter_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Emarsys::ParamsConverter do
+  let(:converter) { Emarsys::ParamsConverter.new({}) }
+
+  before :each do
+    attributes = [
+      {:id => 0,   :identifier => 'interests', :name => 'Interests'},
+      {:id => 1,   :identifier => 'first_name', :name => 'First Name'},
+      {:id => 2,   :identifier => 'last_name',  :name => 'Last Name'},
+    ]
+    stub_const("Emarsys::FieldMapping::ATTRIBUTES", attributes)
+  end
+
+  describe 'with attributes' do
+    it 'sets params attribute on initialize' do
+      params = {1 => 'Jane', 2 => 'Doe'}
+      params_converter = Emarsys::ParamsConverter.new(params)
+      params_converter.params.should eq(params)
+    end
+  end
+
+  context 'converting id-based hashes into string keys' do
+    it 'converts all findable string keys' do
+      converter.params = {'first_name' => 'Jane', 'last_name' => 'Doe'}
+      expect(converter.convert_to_ids).to eq({1 => 'Jane', 2 => 'Doe'})
+    end
+
+    it 'does not convert non-findable keys' do
+      converter.params = {'first_name' => 'Jane', 'last_name' => 'Doe', 'something' => 'abc'}
+      expect(converter.convert_to_ids).to eq({1 => 'Jane', 2 => 'Doe', 'something' => 'abc'})
+    end
+  end
+
+  context 'converting string-based hashes into id keys' do
+    it 'converts all findable keys' do
+      converter.params = {1 => 'Jane', 2 => 'Doe'}
+      expect(converter.convert_to_identifiers).to eq({'first_name' => 'Jane', 'last_name' => 'Doe'})
+    end
+
+    it 'does not convert 0-key (since ''.to_i, which is 0, is a relevant field at emarsys)' do
+      converter.params = {0 => 'Yeah', 1 => 'Jane', 2 => 'Doe'}
+      expect(converter.convert_to_identifiers).to eq({0 => 'Yeah', 'first_name' => 'Jane', 'last_name' => 'Doe'})
+    end
+
+    it 'does not convert non-findable keys' do
+      converter.params = {1 => 'Jane', 2 => 'Doe', 4 => 'something'}
+      expect(converter.convert_to_identifiers).to eq({'first_name' => 'Jane', 'last_name' => 'Doe', 4 => 'something'})
+    end
+  end
+
+end

data/spec/emarsys/request_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Emarsys::Request do
+  let(:client) { Emarsys::Client.new }
+  let(:request) { Emarsys::Request.new('get', 'some-path', {:a => 1}) }
+
+  describe '#initialize' do
+    it 'sets client, path, http_verb and params attributes on initialize' do
+      expect(request.http_verb).to eq('get')
+      expect(request.path).to eq("some-path")
+      expect(request.params).to eq({:a => 1})
+    end
+  end
+
+  describe '#client' do
+    it "provides a simple client accessor method" do
+      expect(request.client).to be_a(Emarsys::Client)
+    end
+  end
+
+  describe '#emarsys_uri' do
+    it 'concats api_endpoint with path' do
+      expect(request.emarsys_uri).to eq("https://suite5.emarsys.net/api/v2/some-path")
+    end
+  end
+
+end

data/spec/emarsys/response_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Emarsys::Response do
+
+  describe '#initialize' do
+    it 'sets code, text and data attributes on initialize' do
+      response_string = "{\"replyCode\":0,\"replyText\":\"Something\",\"data\":1}"
+      response = Emarsys::Response.new(response_string)
+      expect(response.code).to eq(0)
+      expect(response.text).to eq("Something")
+      expect(response.data).to eq(1)
+    end
+  end
+
+  describe '#result' do
+    let(:response) { Emarsys::Response.new("{\"replyCode\":0,\"replyText\":\"Something\",\"data\":1}") }
+
+    it "returns data if code is 0" do
+      response.stub(:code).and_return(0)
+      expect(response.result).to eq(1)
+    end
+
+    it "raises BadRequest error if code is not 0" do
+      response.stub(:code).and_return(1)
+      expect{response.result}.to raise_error(Emarsys::BadRequest)
+    end
+
+    it "raises Unauthorized error if http-status is 401" do
+      response.stub(:code).and_return(1)
+      response.stub(:status).and_return(401)
+      expect{response.result}.to raise_error(Emarsys::Unauthorized)
+    end
+  end
+
+end

data/spec/emarsys_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Emarsys do
+
+  describe ".configure" do
+    [:api_endpoint, :api_username, :api_password].each do |key|
+      it "sets the #{key.to_s.gsub('_', ' ')}" do
+        Emarsys.configure do |config|
+          config.send("#{key}=", key)
+        end
+        expect(Emarsys.instance_variable_get(:"@#{key}")).to eq key
+      end
+    end
+  end
+
+  describe ".api_endpoint getter" do
+    it "returns specific url as default value" do
+      Emarsys.api_endpoint = nil
+      Emarsys.api_endpoint.should eq('https://suite5.emarsys.net/api/v2')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'emarsys'
+require 'rspec'
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+
+  config.before(:all) { stub_emarsys_authentication! }
+end
+
+def stub_emarsys_authentication!
+  Emarsys.configure do |config|
+    config.api_username = "my_username"
+    config.api_password = "my_password"
+  end
+end
+
+def standard_return_body
+  {:body => "{\"replyCode\":0,\"replyText\":\"Something\",\"data\":1}"}
+end
+
+def stub_get(path, &block)
+  stub = stub_request(:get, "https://suite5.emarsys.net/api/v2/#{path}").to_return(standard_return_body)
+  yield if block_given?
+  stub
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: emarsys
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Daniel Schoppmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: A Ruby library for interacting with the Emarsys API.
+email:
+- daniel.schoppmann@absolventa.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- emarsys.gemspec
+- lib/emarsys.rb
+- lib/emarsys/client.rb
+- lib/emarsys/data_object.rb
+- lib/emarsys/data_objects/condition.rb
+- lib/emarsys/data_objects/contact.rb
+- lib/emarsys/data_objects/contact_list.rb
+- lib/emarsys/data_objects/email.rb
+- lib/emarsys/data_objects/email_category.rb
+- lib/emarsys/data_objects/email_launch_status.rb
+- lib/emarsys/data_objects/email_status_code.rb
+- lib/emarsys/data_objects/event.rb
+- lib/emarsys/data_objects/export.rb
+- lib/emarsys/data_objects/field.rb
+- lib/emarsys/data_objects/file.rb
+- lib/emarsys/data_objects/folder.rb
+- lib/emarsys/data_objects/form.rb
+- lib/emarsys/data_objects/language.rb
+- lib/emarsys/data_objects/segment.rb
+- lib/emarsys/data_objects/source.rb
+- lib/emarsys/error.rb
+- lib/emarsys/extensions.rb
+- lib/emarsys/field_mapping.rb
+- lib/emarsys/params_converter.rb
+- lib/emarsys/request.rb
+- lib/emarsys/response.rb
+- lib/emarsys/version.rb
+- spec/emarsys/client_spec.rb
+- spec/emarsys/data_object_spec.rb
+- spec/emarsys/data_objects/condition_spec.rb
+- spec/emarsys/data_objects/contact_list_spec.rb
+- spec/emarsys/data_objects/contact_spec.rb
+- spec/emarsys/data_objects/email_category_spec.rb
+- spec/emarsys/data_objects/email_launch_status_spec.rb
+- spec/emarsys/data_objects/email_spec.rb
+- spec/emarsys/data_objects/email_status_code_spec.rb
+- spec/emarsys/data_objects/event_spec.rb
+- spec/emarsys/data_objects/export_spec.rb
+- spec/emarsys/data_objects/field_spec.rb
+- spec/emarsys/data_objects/file_spec.rb
+- spec/emarsys/data_objects/folder_spec.rb
+- spec/emarsys/data_objects/form_spec.rb
+- spec/emarsys/data_objects/language_spec.rb
+- spec/emarsys/data_objects/segment_spec.rb
+- spec/emarsys/data_objects/source_spec.rb
+- spec/emarsys/extensions_spec.rb
+- spec/emarsys/field_mapping_spec.rb
+- spec/emarsys/params_converter_spec.rb
+- spec/emarsys/request_spec.rb
+- spec/emarsys/response_spec.rb
+- spec/emarsys_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.absolventa.de
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Easy to use ruby library for Emarsys Marketing Suite.
+test_files:
+- spec/emarsys/client_spec.rb
+- spec/emarsys/data_object_spec.rb
+- spec/emarsys/data_objects/condition_spec.rb
+- spec/emarsys/data_objects/contact_list_spec.rb
+- spec/emarsys/data_objects/contact_spec.rb
+- spec/emarsys/data_objects/email_category_spec.rb
+- spec/emarsys/data_objects/email_launch_status_spec.rb
+- spec/emarsys/data_objects/email_spec.rb
+- spec/emarsys/data_objects/email_status_code_spec.rb
+- spec/emarsys/data_objects/event_spec.rb
+- spec/emarsys/data_objects/export_spec.rb
+- spec/emarsys/data_objects/field_spec.rb
+- spec/emarsys/data_objects/file_spec.rb
+- spec/emarsys/data_objects/folder_spec.rb
+- spec/emarsys/data_objects/form_spec.rb
+- spec/emarsys/data_objects/language_spec.rb
+- spec/emarsys/data_objects/segment_spec.rb
+- spec/emarsys/data_objects/source_spec.rb
+- spec/emarsys/extensions_spec.rb
+- spec/emarsys/field_mapping_spec.rb
+- spec/emarsys/params_converter_spec.rb
+- spec/emarsys/request_spec.rb
+- spec/emarsys/response_spec.rb
+- spec/emarsys_spec.rb
+- spec/spec_helper.rb
+has_rdoc: