clever_reach 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGVkNzU2NTg3NTEyZWUwMDdmMGMzMjFhMGQ0NDZhY2YyMDk2ZTI2OQ==
+  data.tar.gz: !binary |-
+    ZWQ0ZmQ0OTllNzA3YzljYWE1ZGI4MjRhMTM2ZGZjMDEyZmZmOGY5Yg==
+SHA512:
+  metadata.gz: !binary |-
+    Mjg0MGU2MjNjODRhYWE1OTY3NGZhYjFkOWNkYzcyMjE3MDNmMjU4ZWMwYmZm
+    Zjk5OTU1NGU1OWNmMmE5ZDg0OGM2NWRlZGQ0OTRlMGZlNGYzMDE2NGIwMzE0
+    OWU3ZmEyNDJlZWMwOGRhODNjNTdlMGI4YjA1OWEyNGRhZjRjZDA=
+  data.tar.gz: !binary |-
+    NTE1Yzg1ZWVkNzRkNDVhYzkyNTYzNDFjNjVlNDJiNTU4NGI3ZjZhNzI0NWUz
+    NjdkMDk5MTIyOTcxNGE3YTExNWQyOGVjYzYzYzAyZDdiYWZjYWIzZDJhNjY2
+    ZmJmNDBkNmZmNDRhMDM3MjA4NzA3ODIzOTY4NzY1NTE1OTM5MzE=

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*~

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in cleverreach.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012, 2013 Stephan Schubert <stephan@frozencherry.de>
+
+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,27 @@
+# clever_reach
+
+Ruby bindings for CleverReach's API
+
+[![Code Climate](https://codeclimate.com/github/jazen/clever_reach.png)](https://codeclimate.com/github/jazen/clever_reach)
+
+## Installation
+
+In your Gemfile:
+
+``` ruby
+gem 'clever_reach'
+```
+
+## Introduction
+
+``` ruby
+require 'clever_reach'
+
+CleverReach.configure do |config|
+  config.api_key = "12345" # Replace with your API key
+end
+
+api  = CleverReach::Base.new
+resp = api.client_get_details
+resp.to_hash # => { :id => '12345', :first_name => 'Stephan', ... }
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/clever_reach.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "clever_reach/version"
+
+Gem::Specification.new do |s|
+  s.name        = "clever_reach"
+  s.version     = CleverReach::VERSION
+  s.authors     = ["Stephan Schubert"]
+  s.email       = ["stephan@frozencherry.de"]
+  s.homepage    = "https://github.com/jazen/clever_reach"
+  s.summary     = "Ruby bindings for CleverReach's API"
+  s.description = "Ruby bindings for CleverReach's API"
+  s.licenses    = %w(MIT)
+
+  s.rubyforge_project = "clever_reach"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'savon_spec'
+
+  s.add_runtime_dependency 'savon', '~> 1.0'
+end

data/lib/clever_reach.rb

@@ -0,0 +1,16 @@
+require "clever_reach/version"
+
+module CleverReach
+  autoload :Base,              'clever_reach/base'
+  autoload :Configuration,     'clever_reach/configuration'
+  autoload :Errors,            'clever_reach/errors'
+  autoload :ResponseDecorator, 'clever_reach/response_decorator'
+
+  def self.config
+    Configuration.instance
+  end
+
+  def self.configure
+    yield config
+  end
+end

data/lib/clever_reach/base.rb

@@ -0,0 +1,36 @@
+require 'savon'
+
+module CleverReach
+  class Base
+    attr_reader :api_key
+
+    def initialize
+      @api_key = CleverReach.config.api_key
+    end
+
+    def client
+      @client ||= Savon.client(CleverReach.config.wsdl_url)
+    end
+
+    def method_missing(name, *args)
+      options  = args.last.is_a?(Hash) ? args.pop : {}
+      response = request(name, options)
+
+      ResponseDecorator.new(response).tap do |r|
+        raise Errors.lookup(r.status_code) unless r.valid?
+      end
+    end
+
+    private # ----------------------------------------------
+
+    def request(method_name, body)
+      # The 'apiKey' MUST come first in the *ordered* hash.
+      body = { 'apiKey' => @api_key }.merge(body)
+
+      client.request(method_name) do
+        soap.body = body
+      end
+    end
+
+  end
+end

data/lib/clever_reach/configuration.rb

@@ -0,0 +1,21 @@
+require 'singleton'
+
+module CleverReach
+  class Configuration
+    include Singleton
+
+    @@defaults = {
+      wsdl_url: 'http://api.cleverreach.com/soap/interface_v5.1.php?wsdl'
+    }
+
+    attr_accessor :wsdl_url, :api_key, :list_id
+
+    def self.defaults
+      @@defaults
+    end
+
+    def initialize
+      @@defaults.each { |k,v| send("#{k}=", v) }
+    end
+  end
+end

data/lib/clever_reach/errors.rb

@@ -0,0 +1,113 @@
+module CleverReach
+  module Errors
+    # http://support.cleverreach.de/entries/20674817-fehlercode-api
+
+    class BaseError < StandardError
+    end
+
+    class InvalidAPIKey < BaseError
+      def initialize
+        super('invalid API key')
+      end
+    end
+
+    class NeedSessionBeforeUsage < BaseError
+      def initialize
+        super('need session before usage')
+      end
+    end
+
+    class PermissionDenied < BaseError
+      def initialize
+        super('permission denied')
+      end
+    end
+
+    class DataNotFound < BaseError
+      def initialize
+        super('data not found')
+      end
+    end
+
+    class EmailInvalid < BaseError
+      def initialize
+        super('email invalid')
+      end
+    end
+
+    class EmailBlacklisted < BaseError
+      def initialize
+        super('email blacklisted')
+      end
+    end
+
+    class DuplicateData < BaseError
+      def initialize
+        super('duplicate data')
+      end
+    end
+
+    class SubscriberAlreadyActive < BaseError
+      def initialize
+        super('subscriber already active')
+      end
+    end
+
+    class InsertingOrderFailed < BaseError
+      def initialize
+        super('inserting order failed')
+      end
+    end
+
+    class BatchTooBig < BaseError
+      def initialize
+        super('batch too big (max 50)')
+      end
+    end
+
+    class SubscriberAlreadyInactive < BaseError
+      def initialize
+        super('subscriber already inactive')
+      end
+    end
+
+    class GivenEmailIsTooShort < BaseError
+      def initialize
+        super('given email is too short')
+      end
+    end
+
+    class NoFormsAvailable < BaseError
+      def initialize
+        super('no forms available')
+      end
+    end
+
+    class ErrorSavingFilter < BaseError
+      def initialize
+        super('error saving filter')
+      end
+    end
+
+    ErrorMap = {
+      1   => InvalidAPIKey,
+      5   => NeedSessionBeforeUsage,
+      10  => PermissionDenied,
+      20  => DataNotFound,
+      30  => EmailInvalid,
+      40  => EmailBlacklisted,
+      50  => DuplicateData,
+      60  => SubscriberAlreadyActive,
+      70  => InsertingOrderFailed,
+      80  => BatchTooBig,
+      90  => SubscriberAlreadyInactive,
+      100 => GivenEmailIsTooShort,
+      110 => NoFormsAvailable,
+      120 => ErrorSavingFilter,
+    }
+
+    def self.lookup(code)
+      ErrorMap[code]
+    end
+  end
+end

data/lib/clever_reach/response_decorator.rb

@@ -0,0 +1,44 @@
+module CleverReach
+  class ResponseDecorator < SimpleDelegator
+
+    def initialize(response)
+      super
+      @response = response
+    end
+
+    def valid?
+      # Let's be flexible when checking for the status.
+      answer_hash[:status] =~ /success/i
+    end
+
+    def status_code
+      answer_hash[:statuscode].to_i
+    end
+
+    def to_hash
+      data = answer_hash[:data]
+      clean! data.dup
+    end
+
+    private # ----------------------------------------------
+
+    def response_hash_key
+      @response.body.keys.find { |k| k.to_s =~ /_response$/ }
+    end
+
+    def answer_hash
+      @response.body[response_hash_key][:return]
+    end
+
+    def clean!(hash)
+      hash.reject! do |k,v|
+        if v.is_a? Hash
+          clean!(v); false
+        else
+          k.to_s =~ /^@/
+        end
+      end
+    end
+
+  end
+end

data/lib/clever_reach/version.rb

@@ -0,0 +1,3 @@
+module CleverReach
+  VERSION = "0.0.1"
+end

data/spec/clever_reach/base_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe CleverReach::Base do
+
+  let(:wsdl_url) { "http://api.test.com/wsdl" }
+  let(:api_key)  { "12345" }
+  let(:client)   { subject.client }
+
+  before :all do
+    CleverReach.configure do |config|
+      config.wsdl_url = wsdl_url
+      config.api_key  = api_key
+    end
+  end
+
+  describe "#new" do # -------------------------------------
+
+    it "should use the configured API key" do
+      subject.api_key.should == api_key
+    end
+
+  end
+
+  describe "#client" do # ----------------------------------
+
+    it "should return configured Savon::Client" do
+      client.should be_instance_of(Savon::Client)
+      client.wsdl.document.should == wsdl_url
+    end
+
+    it "should re-use the client" do
+      client.should == client
+    end
+
+  end
+
+  describe "Response w/ errors" do # -----------------------
+
+    let(:body_with_errors) do
+      { :foo_response => { :return => { :status => 'ERROR', :statuscode => '30' } } }
+    end
+
+    let(:response) { stub(body: body_with_errors) }
+
+    before :each do
+      subject.should_receive(:request).with(:foo, anything).and_return(response)
+    end
+
+    it "should raise the appropiate error" do
+      lambda { subject.foo }.should raise_error(CleverReach::Errors::EmailInvalid)
+    end
+
+  end
+
+  # TODO Can't figure out how to stub/mock requests for Savon.
+  #      I'v opened a new issue on github asking for some documentation.
+  #
+  #      https://github.com/rubiii/savon/issues/307
+  #
+  # it "blah" do
+  #   savon.expects(:client_get_details).with('apiKey' => api_key).returns({})
+  #   subject.client_get_details
+  # end
+
+  # describe "A request" do # --------------------------------
+
+  #   it "should return a ResponseDecorator" do
+  #     subject.foobar.should be_instance_of(ResponseDecorator)
+  #   end
+
+  # end
+
+end

data/spec/clever_reach/configuration_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe CleverReach::Configuration do
+
+  let(:klass)   { CleverReach::Configuration }
+  let(:subject) { CleverReach.config }
+
+  it "should be a singleton" do
+    klass.included_modules.should include(Singleton)
+  end
+
+  describe "Default configuration" do
+
+    let(:defaults) do
+      {
+        wsdl_url: 'http://api.cleverreach.com/soap/interface_v5.1.php?wsdl'
+      }
+    end
+
+    it "should have some default settings" do
+      klass.defaults.should == defaults
+    end
+
+    it "should use the default settings automatically" do
+      keys = subject.instance_variables.map { |name| name.to_s.sub('@', '').to_sym }
+      keys.should include(*defaults.keys)
+    end
+
+  end
+
+  describe "Specifying a list id" do
+
+    before :each do
+      CleverReach.configure do |config|
+        config.list_id = '123'
+      end
+    end
+
+    it "should be readable" do
+      subject.list_id.should == '123'
+    end
+
+  end
+
+end

data/spec/clever_reach/errors_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+describe CleverReach::Errors do
+
+  describe CleverReach::Errors::BaseError do # -------------
+
+    let(:subject) { CleverReach::Errors::BaseError.new }
+
+    it "should be subclass of StandardError" do
+      subject.should be_kind_of(StandardError)
+    end
+
+  end
+
+  describe "Custom errors" do # ----------------------------
+
+    let(:error_scope) { CleverReach::Errors }
+    let(:error_class) { error_scope::BaseError }
+
+    it "should define an error for 'invalid API Key'" do
+      error = error_scope::InvalidAPIKey.new
+      error.should be_kind_of(error_class)
+      error.message.should == 'invalid API key'
+    end
+
+    it "should define an error for 'need session before usage'" do
+      error = error_scope::NeedSessionBeforeUsage.new
+      error.should be_kind_of(error_class)
+      error.message.should == 'need session before usage'
+    end
+
+    it "should define an error for 'permission denied'" do
+      error = error_scope::PermissionDenied.new
+      error.should be_kind_of(error_class)
+      error.message.should == 'permission denied'
+    end
+
+    it "should define an error for 'data not found'" do
+      error = error_scope::DataNotFound.new
+      error.should be_kind_of(error_class)
+      error.message.should == 'data not found'
+    end
+
+    it "should define an error for 'email invalid'" do
+      error = error_scope::EmailInvalid.new
+      error.should be_kind_of(error_class)
+      error.message.should == 'email invalid'
+    end
+
+    it "should define an error for 'email blacklisted'" do
+      error = error_scope::EmailBlacklisted.new
+      error.should be_kind_of(error_class)
+      error.message.should == 'email blacklisted'
+    end
+
+    it "should define an error for 'duplicate data'" do
+      error = error_scope::DuplicateData.new
+      error.should be_kind_of(error_class)
+      error.message.should == 'duplicate data'
+    end
+
+    it "should define an error for 'subscriber already active'" do
+      error = error_scope::SubscriberAlreadyActive.new
+      error.should be_kind_of(error_class)
+      error.message.should == 'subscriber already active'
+    end
+
+    it "should define an error for 'inserting order failed'" do
+      error = error_scope::InsertingOrderFailed.new
+      error.should be_kind_of(error_class)
+      error.message.should == 'inserting order failed'
+    end
+
+    it "should define an error for 'batch to big (max 50)'" do
+      error = error_scope::BatchTooBig.new
+      error.should be_kind_of(error_class)
+      error.message.should == 'batch too big (max 50)'
+    end
+
+    it "should define an error for 'subscriber already inactive'" do
+      error = error_scope::SubscriberAlreadyInactive.new
+      error.should be_kind_of(error_class)
+      error.message.should == 'subscriber already inactive'
+    end
+
+    it "should define an error for 'given email is too short'" do
+      error = error_scope::GivenEmailIsTooShort.new
+      error.should be_kind_of(error_class)
+      error.message.should == 'given email is too short'
+    end
+
+    it "should define an error for 'no forms available'" do
+      error = error_scope::NoFormsAvailable.new
+      error.should be_kind_of(error_class)
+      error.message.should == 'no forms available'
+    end
+
+    it "should define an error for 'error saving filter'" do
+      error = error_scope::ErrorSavingFilter.new
+      error.should be_kind_of(error_class)
+      error.message.should == 'error saving filter'
+    end
+
+  end
+
+  describe ".lookup" do # ----------------------------------
+
+    CleverReach::Errors::ErrorMap.each do |code, klass|
+      it "should map error code #{code} to an error class '#{klass.name}'" do
+        subject.lookup(code).should == klass
+      end
+    end
+
+  end
+
+
+end

data/spec/clever_reach/response_decorator_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe CleverReach::ResponseDecorator do
+
+  let(:body) do
+    { :client_get_details_response => {
+        :return => {
+          :status => "SUCCESS",
+          :message => { :"@xsi:type" => "xsd:string" },
+          :statuscode => "0",
+          :data => {
+            :id => "12345",
+            :firstname => "Stephan",
+            :name => "Schubert",
+            :company => "avianta UG",
+            :email => "stephan@frozencherry.de",
+            :login_domain => "12345.cleverreach.com",
+            :item => { :foo => "1", :"@xsi:type" => "foo" },
+            :"@xsi:type" => "tns:clientData"
+          },
+          :"@xsi:type" => "tns:returnClient" },
+        :"@xmlns:ns1"=>"CRS"
+      }
+    }
+  end
+
+  let(:response) { stub(body: body) }
+  let(:subject)  { CleverReach::ResponseDecorator.new(response) }
+
+  describe "Method Delegation" do # ------------------------
+    let(:response) { stub(body: body, foo: 1) }
+
+    it "should check the underlying object" do
+      subject.foo.should == 1
+    end
+  end
+
+  describe "#to_hash" do # ----------------------------------
+
+    it "should return a cleaned hash with just the valuable data" do
+      subject.to_hash.should == {
+        id: "12345",
+        firstname: "Stephan",
+        name: "Schubert",
+        company: "avianta UG",
+        email: "stephan@frozencherry.de",
+        login_domain: "12345.cleverreach.com",
+        item: { foo: "1" }
+      }
+    end
+
+  end
+
+  describe "Response w/o errors" do # ----------------------
+    it { should be_valid }
+
+    it "should have status code 0" do
+      subject.status_code.should be_zero
+    end
+  end
+
+  describe "Response w/ errors" do # -----------------------
+    let(:body) do
+      { :some_method_response => {
+          :return => { :status => 'ERROR', :statuscode => '40' }
+        }
+      }
+    end
+
+    it { should_not be_valid }
+
+    it "should have a non-zero status code" do
+      subject.status_code.should_not be_zero
+    end
+  end
+
+end

data/spec/clever_reach_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe CleverReach do
+
+  let(:klass) { CleverReach }
+
+  it "should have a VERSION" do
+    klass::VERSION.should_not be_nil
+  end
+
+  describe "Configuration" do # ----------------------------
+
+    it "should have a configuration instance" do
+      klass.config.should be_instance_of(klass::Configuration)
+    end
+
+    it "should support configuration with a block" do
+      klass::Configuration.class_eval { attr_accessor :foo }
+
+      klass.configure do |config|
+        config.foo = :bar
+      end
+
+      klass.config.foo.should == :bar
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+# Setup rubygems/bundler
+require 'rubygems'
+require 'bundler/setup'
+
+require 'savon'
+require 'savon_spec'
+
+# The gem itself
+require 'clever_reach'
+
+# 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"` to ensure that it is only
+# loaded once.
+#
+# 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
+
+  config.include Savon::Spec::Macros
+
+  # 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'
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: clever_reach
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stephan Schubert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: savon_spec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: savon
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  prerelease: false
+description: Ruby bindings for CleverReach's API
+email:
+- stephan@frozencherry.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- clever_reach.gemspec
+- lib/clever_reach.rb
+- lib/clever_reach/base.rb
+- lib/clever_reach/configuration.rb
+- lib/clever_reach/errors.rb
+- lib/clever_reach/response_decorator.rb
+- lib/clever_reach/version.rb
+- spec/clever_reach/base_spec.rb
+- spec/clever_reach/configuration_spec.rb
+- spec/clever_reach/errors_spec.rb
+- spec/clever_reach/response_decorator_spec.rb
+- spec/clever_reach_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jazen/clever_reach
+licenses:
+- MIT
+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: clever_reach
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for CleverReach's API
+test_files:
+- spec/clever_reach/base_spec.rb
+- spec/clever_reach/configuration_spec.rb
+- spec/clever_reach/errors_spec.rb
+- spec/clever_reach/response_decorator_spec.rb
+- spec/clever_reach_spec.rb
+- spec/spec_helper.rb
+has_rdoc: