clever_elements 0.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011, Marian Theisen
+
+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,80 @@
+clever\_elements
+================
+
+[![Build Status](https://secure.travis-ci.org/cice/clever_elements.png)](http://travis-ci.org/cice/clever_elements)
+
+
+**Under Development, any help appreciated!**
+
+**clever\_elements** is a RubyGem to use the **CleverElements SOAP Api** with Ruby / Rails.
+
+Rails 3 Quickstart
+------------------
+
+The easiest way to use **clever\_elements** is with Rails 3. Just extend your Gemfile
+
+    gem 'clever_elements', '~> 0.0.1'
+    
+put a `clever_elements.yml` file in your `#{Rails.root}/config`:
+
+    user_id: <your user id>
+    api_key: <your api key>
+    mode: <test or live>
+    
+And use the `CleverElements::List` and `CleverElements::Subscriber` models, e.g.
+
+    # Get the ids of all lists in your account:
+    CleverElements::List.ids
+    # => ['73302']
+    
+    # Get the list for a specific id:
+    CleverElements::List.find '73302'
+    # => <CleverElements::List:0x007fb78a8ab8f0 @id="73302", @name="ABC", @description="foobar", @subscriber="0", @unsubscriber="0">
+
+    # Get all lists in your account:
+    CleverElements::List.all
+    # => [<CleverElements::List:0x007fb78a8ab8f0 @id="73302", @name="ABC", @description="foobar", @subscriber="0", @unsubscriber="0">]
+    
+    # Create a new list:
+    list = CleverElements::List.new :name => 'baz'
+    list.id
+    # => nil
+    list.create
+    # => true
+    list.id 
+    # => 73303
+    
+    # Remove a list:
+    list = CleverElements::List.find('73302')
+    list.id
+    # => 73302
+    list.destroy
+    # => true
+    list.id
+    # => nil
+    
+    # Get the subscribers in a list
+    list = CleverElements::List.find('73302')
+    list.subscriber
+    # => [<CleverElements::Subscriber:0x007fb78a8ab8f0 @id='123123', @email='max@muster.de'>]
+    
+    # or
+    CleverElements::Subscriber.all '73302'
+    # => [<CleverElements::Subscriber:0x007fb78a8ab8f0 @id='123123', @email='max@muster.de'>]
+    
+    # Add a subscriber
+    subscriber = list.create_subscriber :email => 'max@muster.de'
+    # => <CleverElements::Subscriber:0x007fb78a8ab8f0 @id='123143', @email='max@muster.de'>
+    
+    # Unsubscribe
+    subscriber.unsubscribe_from_all
+    
+### What doesn't work / hasn't been implemented yet?
+* custom fields
+* unsubscribe\_from\_list (implemented but API request doesn't work)
+
+### What could be improved?
+* extensions/wasabi\_parser.rb
+* comprehensive exception handling
+* environment dependent configuration (development, test, production)
+* test / spec helpers

data/lib/clever_elements/client.rb

@@ -0,0 +1,34 @@
+module CleverElements
+  class Client
+    API_VERSION = "1.0"
+    
+    attr_reader :savon, :user_id, :api_key, :mode
+    
+    def initialize user_id, api_key, mode = 'test'
+      @savon = Savon::Client.new "http://api.sendcockpit.com/server.php?wsdl"
+      @user_id, @api_key, @mode = user_id, api_key, mode
+    end
+    
+    def request method, arguments = {}
+      savon.request method do
+        soap.body = arguments
+        soap.header = authentication_header
+      end
+    end
+    
+    def authentication_header
+      {
+        :validate => {
+          :userid => user_id,
+          :apikey => api_key,
+          :version => API_VERSION,
+          :mode => mode
+        }
+      }
+    end
+    
+    def proxy
+      @proxy ||= Proxy.new self
+    end
+  end
+end

data/lib/clever_elements/list.rb

@@ -0,0 +1,138 @@
+require 'active_support/core_ext/hash/keys'
+require 'clever_elements/model'
+
+module CleverElements
+  class List < Model
+    class << self
+      def find id
+        response = proxy.get_list_details :listID => id
+        return nil if response[:list_id].nil?
+        
+        description = response[:description]
+        description = String === description ? description : ''
+        attributes = {
+          :id => response[:list_id],
+          :name => response[:list_name],
+          :description => description,
+          :subscriber_count => response[:list_subscriber],
+          :unsubscriber_count => response[:list_unsubscriber]
+        }
+        
+        new attributes
+      end
+      
+      def ids
+        response = proxy.get_list
+        
+        ids = if Array === response[:item]
+          response[:item].map do |id_response|
+            id_response[:list_id]
+          end
+        elsif Hash === response[:item]
+          [response[:item][:list_id]]
+        else
+          []
+        end
+      rescue Savon::SOAP::Fault
+        []
+      end
+      
+      def all
+        ids.map do |id|
+          find(id)
+        end
+      end
+      
+      def first
+        first_id = ids.first
+        
+        first_id && find(first_id)
+      end
+    end
+    
+    Attributes = [:id, :name, :description, :subscriber_count, :unsubscriber_count]
+    attr_accessor *Attributes
+    
+    def initialize attributes = {}
+      attributes = attributes.symbolize_keys
+      
+      Attributes.each do |attribute|
+        instance_variable_set "@#{attribute}", attributes[attribute]
+      end
+    end
+    
+    def create
+      return true if id
+      
+      response = proxy.add_list list_attributes
+      
+      if response == '200'
+        @id = self.class.ids.last
+        true
+      end
+    rescue Savon::SOAP::Fault
+      false
+    end
+    
+    def destroy
+      response = proxy.delete_list :listID => id
+      
+      if response == '200'
+        @id = nil
+        true
+      else
+        false
+      end    
+    rescue Savon::SOAP::Fault
+      false
+    end
+    
+    def subscriber
+      return [] unless id
+      
+      @subscriber ||= CleverElements::Subscriber.all(id).tap do |s|
+        s.each do |subscriber|
+          assign_list_to_subscriber subscriber
+        end
+      end
+    end
+    
+    def build_subscriber attributes = {}
+      CleverElements::Subscriber.new(attributes.merge(:list_id => id)).tap do |subscriber|
+        assign_list_to_subscriber subscriber
+      end
+    end
+    
+    def create_subscriber attributes = {}
+      subscriber = build_subscriber attributes
+      
+      if subscriber.create
+        subscriber
+      else
+        false
+      end
+    end
+    
+    def create_subscriber_doi attributes = {}
+      subscriber = build_subscriber attributes
+      
+      if subscriber.create_doi
+        subscriber
+      else
+        false
+      end
+    end
+    
+    protected
+    def assign_list_to_subscriber subscriber
+      subscriber.instance_variable_set "@list", self
+    end
+    
+    def list_attributes
+      {
+        :list_name => name,
+        :list_description => description
+      }
+    end
+  end
+end

data/lib/clever_elements/model.rb

@@ -0,0 +1,9 @@
+require 'active_support/core_ext/class/attribute'
+
+module CleverElements
+  class Model
+    class_attribute :proxy
+    
+    
+  end
+end

data/lib/clever_elements/proxy.rb

@@ -0,0 +1,90 @@
+require 'active_support/basic_object'
+
+module CleverElements
+  class Proxy
+    attr_reader :client, :wsdl, :proxy_methods, :response_methods
+    
+    def initialize client
+      @client = client
+      @wsdl = client.savon.wsdl
+      @proxy_methods = Module.new
+      @response_methods = Module.new
+      
+      build_proxy
+    end
+    
+    protected
+    def build_proxy
+      wsdl.operations.each_pair do |name, vals|
+        build_operation_proxy_for name
+      end
+      
+      extend proxy_methods
+      extend response_methods
+    end
+    
+    # Builds a response processor for a SOAP action:
+    # The response processor uses message and type information of the
+    # wsdl to "un-nest" the soap response as far as possible,
+    # e.g. if the soap response is
+    #   :a => { 
+    #     :b => { 
+    #       :c => { 
+    #         :d => 1, 
+    #         :e => 2 
+    #       }
+    #     }
+    #   }
+    # the processor will return
+    #   { :d => 1, :e => 2}
+    # (first non-trivial nesting level)
+    def build_response_processor_for name
+      method_name = "process_response_for_#{name}"
+      message_name, message = wsdl.parser.port_type[name][:output].first
+      key, type = message.first
+      types = wsdl.parser.types
+      keys = [message_name.snakecase.to_sym, key.snakecase.to_sym]
+      while type
+        type = type.split(':').last
+        typedef = types[type]
+      
+        if typedef
+          _keys = (typedef.keys - [:namespace, :type])
+          break unless _keys.length == 1
+          key = _keys.first
+          
+          type = typedef[key][:type]
+          keys << key.snakecase.to_sym
+        else
+          break
+        end
+      end
+      
+      response_methods.send :define_method, method_name do |body|
+        keys.inject body do |b, key|
+          b[key] if b
+        end
+      end
+      
+      method_name
+    end
+    
+    def build_operation_proxy_for name
+      method_name = name.to_s.sub /^api_/, ''
+      input_message = wsdl.parser.port_type[name][:input].first
+      
+      response_processor_name = build_response_processor_for name
+      
+      proxy_methods.send :define_method, method_name do |*args|
+        arguments = args.first
+        
+        if input_message
+          arguments = { input_message.to_sym => arguments }
+        end
+        
+        response = client.request name, arguments
+        send response_processor_name, response.body
+      end
+    end
+  end
+end

data/lib/clever_elements/railtie.rb

@@ -0,0 +1,16 @@
+module CleverElements
+  class Railtie < Rails::Railtie
+    initializer 'clever_elements.initialize_client' do |app|
+      config_file = Rails.root.join 'config', 'clever_elements.yml'
+      
+      if File.exists?(config_file)
+        configuration = YAML.load_file config_file
+        
+        client = CleverElements::Client.new *configuration.values_at('user_id', 'api_key', 'mode')
+        CleverElements::Model.proxy = client.proxy
+      else
+        Rails.logger.warn 'Could not find a configuration file for CleverElements.'
+      end
+    end
+  end
+end

data/lib/clever_elements/subscriber.rb

@@ -0,0 +1,147 @@
+require 'active_support/core_ext/hash/keys'
+require 'clever_elements/model'
+
+module CleverElements
+  class Subscriber < Model
+    class << self
+      def all list_id
+        response = proxy.get_subscriber :listID => list_id
+        
+        ids = if Array === response[:item]
+          response[:item].map do |subscriber_response|
+            instantiate subscriber_response, list_id
+          end
+        elsif Hash === response[:item]
+          [instantiate(response[:item], list_id)]
+        else
+          []
+        end
+      rescue Savon::SOAP::Fault
+        []
+      end
+      
+      def all_unsubscribed list_id
+        response = proxy.get_subscriber_unsubscribes :listID => list_id
+        
+        ids = if Array === response[:item]
+          response[:item].map do |subscriber_response|
+            instantiate subscriber_response, list_id
+          end
+        elsif Hash === response[:item]
+          [instantiate(response[:item], list_id)]
+        else
+          []
+        end
+      rescue Savon::SOAP::Fault
+        []
+      end
+      
+      protected
+      def instantiate attributes, list_id
+        attributes = {
+          :id => attributes[:subscriber_id],
+          :email => attributes[:subscriber_email],
+          :list_id => list_id
+        }
+        
+        new attributes
+      end
+    end
+    
+    attr_accessor :id, :email, :list_id
+    
+    def initialize attributes = {}
+      @id, @email, @list_id = attributes.symbolize_keys.values_at(:id, :email, :list_id)
+    end
+    
+    def list
+      @list ||= list_id && CleverElements::List.find(list_id)
+    end
+    
+    def create
+      create_with :add_subscriber
+    end
+    
+    def create_doi
+      create_with :add_subscriber_doi
+    end
+    
+    def destroy
+      response = proxy.delete_subscriber :subscriberIDListShort => { :item => { :subscriberID => id }}
+      
+      if response == '200'
+        true
+      else
+        false
+      end
+    rescue Savon::SOAP::Fault
+      false
+    end
+    
+    def unsubscribe
+      return false unless list_id
+      
+      unsubscribe_from list_id
+    end
+    
+    def unsubscribe_from list_or_id
+      raise 'FIXME'
+      list_id = if CleverElements::List === list_or_id
+        list_or_id.id
+      else
+        list_or_id
+      end
+      
+      response = proxy.unsubscribe_subscriber_from_list :subscriberIDList => { :item => { :subscriberID => id, :listID => list_id}}
+      
+      if response == '200'
+        @list = @list_id = nil if @list_id == list_id
+        true
+      else
+        false
+      end
+    rescue Savon::SOAP::Fault
+      false
+    end
+    
+    def unsubscribe_from_all
+      response = proxy.unsubscribe_subscriber_from_all :subscriberIDList => { :item => { :subscriberID => id }}
+      
+      if response == '200'
+        true
+      else
+        false
+      end
+    rescue Savon::SOAP::Fault
+      false
+    end
+    
+    protected
+    def create_with method
+      return true if id
+      
+      attributes = subscriber_attributes
+      return false unless attributes[:listID] && attributes[:email]
+      
+      response = proxy.send method, :subscriber_list => {
+        :item => attributes
+      }
+      
+      # FIXME: it should return 200, but i get a Hash, have to interpret that as success...
+      if response.is_a?(Hash)
+        @id = self.class.all(list_id).last.id
+        true
+      end
+    rescue Savon::SOAP::Fault
+      false
+    end
+    
+    def subscriber_attributes
+      {
+        :listID => list_id,
+        :email => email,
+        :customFields => { :item => [] }
+      }
+    end
+  end
+end

data/lib/clever_elements.rb

@@ -0,0 +1,14 @@
+require 'extensions/wasabi_parser'
+require 'savon'
+
+if defined?(Rails)
+  require 'clever_elements/railtie'
+end
+
+require 'clever_elements/client'
+require 'clever_elements/proxy'
+require 'clever_elements/list'
+require 'clever_elements/subscriber'
+
+module CleverElements
+end

data/lib/extensions/wasabi_parser.rb

@@ -0,0 +1,73 @@
+require 'wasabi'
+require 'active_support/concern'
+
+# This is a rather bad monkeypatch extending Wasabi to read message definitions from the wsdl file.
+Wasabi::Parser.class_eval do
+  attr_reader :port_type
+  
+  def parse_port_type
+    operations = @document.xpath "s0:definitions/s0:portType/s0:operation", wsdl_ns
+
+    @port_type = {}
+    operations.each do |operation|
+      name = operation.attribute('name').to_s
+      key = name.snakecase.to_sym
+      
+      hash = @port_type[key] = {}
+      
+      if input = operation.at_xpath('s0:input', wsdl_ns)
+        message_name = input.attribute('message').to_s.split(':').last
+        input_message_parts = @document.xpath %Q{s0:definitions/s0:message[@name="#{message_name}"]/s0:part/@name}, wsdl_ns
+        
+        hash[:input] = input_message_parts.map &:to_s
+      end
+      
+      if output = operation.at_xpath('s0:output', wsdl_ns)
+        message_name = output.attribute('message').to_s.split(':').last
+        output_message_parts = @document.xpath %Q{s0:definitions/s0:message[@name="#{message_name}"]/s0:part}, wsdl_ns
+        
+        message = {}.tap do |output|
+          output_message_parts.each do |part|
+            name = part.attribute('name').to_s
+            type = part.attribute('type').to_s
+            
+            output[name] = type
+          end
+        end
+        
+        hash[:output] = { message_name => message }
+      end
+    end
+  rescue
+    # Don't break Wasabi with bad monkeypatching
+  end
+  
+  alias_method :process_type_without_all, :process_type  
+  def process_type(type, name)
+    process_type_without_all type, name
+    return unless type
+    
+    @types[name] ||= { :namespace => find_namespace(type) }
+
+    type.xpath("./xs:all/xs:element",
+      "xs" => "http://www.w3.org/2001/XMLSchema"
+    ).each do |inner_element|
+      @types[name][inner_element.attribute('name').to_s] = {
+        :type => inner_element.attribute('type').to_s
+      }
+    end
+  rescue
+    # Don't break Wasabi with bad monkeypatching
+  end
+  
+  alias_method :parse_without_port_type, :parse
+  def parse
+    parse_without_port_type
+    parse_port_type
+  end
+  
+  protected
+  def wsdl_ns
+    {"s0" => "http://schemas.xmlsoap.org/wsdl/", "xs" => "http://www.w3.org/2001/XMLSchema"}
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: clever_elements
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Marian Theisen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-24 00:00:00.000000000 +02:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70286679111680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70286679111680
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: &70286679111220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *70286679111220
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70286679110840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70286679110840
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: &70286679110380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70286679110380
+- !ruby/object:Gem::Dependency
+  name: savon_spec
+  requirement: &70286679109960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70286679109960
+description: Clever Elements API Client
+email: marian.theisen@kayoom.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- lib/clever_elements/client.rb
+- lib/clever_elements/list.rb
+- lib/clever_elements/model.rb
+- lib/clever_elements/proxy.rb
+- lib/clever_elements/railtie.rb
+- lib/clever_elements/subscriber.rb
+- lib/clever_elements.rb
+- lib/extensions/wasabi_parser.rb
+has_rdoc: true
+homepage: http://github.com/kayoom/clever_elements
+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.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Clever Elements API Client
+test_files: []