cleverelements 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f032559d13407aa76df111ffb09fd325c57a8b7
+  data.tar.gz: 4ff2416e9cba57139dd24df260f3d0bdcf62ceb1
+SHA512:
+  metadata.gz: 0a03f2dce5745b0c3e7316e9884849b2747b746513701bafe0ddcebed3e4a4cbc9580db6f3ceb8c4fa590dab858940daee12e6b4d10f8f9c96e049706532c0c6
+  data.tar.gz: 13a1f2ed432f7a4a4e86d60e10693b859af9b3772c7d9126f6e7d530efe38c75b7a1e9c4abee27644423e2af2e453e1454c17d8bc399d5b42246a0ae061d586b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Zdravko Evstatiev
+
+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 @@
+# cleverelements

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_test.rb"
+end
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cleverelements"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cleverelements.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cleverelements/version'
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = '~> 2.0'
+  spec.name          = "cleverelements"
+  spec.version       = CleverElements::VERSION
+  spec.authors       = ["Despark"]
+  spec.email         = ["contact@despark.com"]
+
+  spec.summary       = "A ruby gem to help you implement [Clever Elements'](http://www.cleverelements.com/, 'Clever Elements') API in your projects. Detailed API documentations can be found here: [http://support.cleverelements.com/kb/api/](http://support.cleverelements.com/kb/api/, 'View API docs')."
+  spec.description   = "The API works with the network protocol SOAP (Simple Object Access Protocol). SOAP libraries can be found in many modern programming languages such as PHP, Python, Java and C++. SOAP therefore provides a good basis for simple cross-language communication. The basis for SOAP is the WSDL file, in which all functions and parameters of the API are described. The WSDL file is provided in XML format and can be read by many editors (e.g. Aptana). [More Info about our API](http://support.cleverelements.com/kb/api/)"
+  spec.homepage      = "http://www.cleverelements.com/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "savon", "~> 2.10", ">= 2.10.0"
+end

data/lib/cleverelements.rb

@@ -0,0 +1,7 @@
+require 'cleverelements/version'
+require 'cleverelements/client'
+require 'cleverelements/subscribers'
+require 'cleverelements/lists'
+
+module CleverElements
+end

data/lib/cleverelements/client.rb

@@ -0,0 +1,89 @@
+require 'savon'
+require 'cleverelements/lists'
+require 'cleverelements/subscribers'
+
+module CleverElements
+  class Client
+    API_VERSION = "1.0"
+    attr_reader :savon
+
+    def initialize(api_id, api_key, mode = 'test')
+      # cli = CleverElements::Client.new('195753', 'ua4zhTpLPaZ9wfpD', 'live')
+      # cli.lists.all
+      # cli.subscribers.find_by_email('email@example.org')
+      # cli.request(:api_get_list)
+      # cli.request(:api_get_list_details, {listID: 335333})
+      # sub_proxy = CleverElements::Subscribers.new(cli)
+      # sub_proxy.find_by_email('email@example.org')
+
+      @savon = Savon.client do
+        wsdl 'http://api.sendcockpit.com/server.php?wsdl'
+        convert_request_keys_to :none
+        soap_header({
+          validate: {
+            userid: api_id,
+            apikey: api_key,
+            version: API_VERSION,
+            mode: mode,
+          }
+        })
+      end
+      define_methods
+    end
+
+    def request(operation, data = {})
+      @savon.call(operation, build_data(operation, data))
+    end
+
+    def build(operation, data = {})
+      @savon.operation(operation).build(build_data(operation, data)).to_s
+    end
+
+    def define_methods
+      @savon.operations.each do |method|
+        self.class.send(:define_method, method) do |args = {}|
+          request(method, args)
+        end
+      end
+    end
+
+    def subscribers
+      CleverElements::Subscribers.new(self)
+    end
+
+    def lists
+      CleverElements::Lists.new(self)
+    end
+
+    private
+    def build_data(operation, data)
+      hash = {}
+      if operation_ct[operation]
+        hash[:message] = {operation_ct[operation] => data}
+      end
+      hash
+    end
+
+    def operation_ct
+      # wsdl.parser.document.css('message[name*=Request]').first.children.css('part').first.attributes["name"].value
+      {
+        api_add_subscriber: :ctSubscriberRequest,
+        api_add_subscriber_doi: :ctSubscriberRequest,
+        api_add_subscriber_field: :ctAddSubscriberFields,
+        api_delete_list: :ctListDetailsRequest,
+        api_delete_subscriber: :ctGetSubscriberIDListShort,
+        api_delete_subscriber_field: :ctDeleteSubscriberFields,
+        api_get_list_details: :ctListDetailsRequest,
+        api_add_list: :ctAddListRequest,
+        api_get_subscriber: :ctListRequest,
+        api_get_subscriber_details: :ctListRequest,
+        api_get_subscriber_by_email: :ctSubscriberEmailRequest,
+        api_get_subscriber_history: :ctGetSubscriberID,
+        api_get_subscriber_subscriptions: :ctSubscriberSubscriptionsRequest,
+        api_get_subscriber_unsubscribes: :ctListRequest,
+        api_unsubscribe_subscriber_from_all: :ctGetSubscriberIDList,
+        api_unsubscribe_subscriber_from_list: :ctGetSubscriberIDList,
+      }
+    end
+  end
+end

data/lib/cleverelements/lists.rb

@@ -0,0 +1,37 @@
+require 'cleverelements/resource'
+
+module CleverElements
+  class Lists < Resource
+    def all
+      @client.api_get_list.body
+    end
+
+    def find(id)
+      @client.api_get_list_details({listID: id}).body
+    end
+
+    def create(name = "", description = "")
+      @client.api_add_list(listName: name, listDescription: description).body
+    end
+
+    def destroy(id)
+      @client.api_delete_list({listID: id}).body
+    end
+
+    def get_subscribers(list_id, offset = 0, limit = 100)
+      # cli.lists.get_subscribers(335333, 0, 100)
+      @client.api_get_subscriber({listID: list_id, start: offset, count: limit}).body
+    end
+
+    def get_subscribers_with_details(list_id, offset = 0, limit = 100)
+      # cli.lists.get_subscribers_with_details(335333, 0, 100)
+      @client.api_get_subscriber_details({listID: list_id, start: offset, count: limit}).body
+    end
+
+    def get_unsubscribed(list_id, offset = 0, limit = 100)
+      # cli.lists.get_unsubscribed(335333, 0, 100)
+      @client.api_get_subscriber_unsubscribes({listID: list_id, start: offset, count: limit}).body
+    end
+  end
+end
+

data/lib/cleverelements/resource.rb

@@ -0,0 +1,7 @@
+module CleverElements
+  class Resource
+    def initialize(client)
+      @client = client
+    end
+  end
+end

data/lib/cleverelements/subscribers.rb

@@ -0,0 +1,112 @@
+require 'cleverelements/resource'
+
+module CleverElements
+  class Subscribers < Resource
+    def history_for(id)
+      @client.api_get_subscriber_history({subscriberID: id}).body
+    end
+
+    def find_by_email(email)
+      @client.api_get_subscriber_by_email({email: email}).body
+    end
+
+    def get_subscriptions(id)
+      @client.api_get_subscriber_subscriptions({subscriberID: id}).body
+    end
+
+    def custom_fields
+      @client.api_get_subscriber_fields.body
+    end
+
+    def create_custom_field(name, type = 1)
+      @client.api_add_subscriber_field(customFieldName: name, customFieldType: type).body
+    end
+
+    def destroy_custom_field(id)
+      @client.api_delete_subscriber_field(customFieldID: id).body
+    end
+
+    def create(attributes)
+      # attributes = [
+      #   {
+      #     list_id: 335333,
+      #     email: "2email@example.org",
+      #     custom_fields: [
+      #       {field_id: 818718, field_value: 'Master'},
+      #     ]
+      #   },
+      #   {
+      #     list_id: 335333,
+      #     email: "3email@example.org",
+      #     custom_fields: [
+      #       {field_id: 818718, field_value: 'The Master'},
+      #     ]
+      #   }
+      # ]
+      @client.api_add_subscriber(build_subscriber_list(attributes)).body
+    end
+
+    def create_doi(attributes)
+      @client.api_add_subscriber_doi(build_subscriber_list(attributes)).body
+    end
+
+    def unsubscribe(subscriber_list)
+      # attributes = [
+      #   {id: 290099412, list_id: 335333},
+      #   {id: 290086837, list_id: 335333}
+      # ]
+
+      @client.api_unsubscribe_subscriber_from_list(build_subscriber_id_list(subscriber_list)).body
+    end
+
+    def unsubscribe_from_all(subscriber_list)
+      @client.api_unsubscribe_subscriber_from_all(build_subscriber_id_list(subscriber_list)).body
+    end
+
+    def destroy(ids)
+      # ids = [290099412, 290099401]
+      @client.api_delete_subscriber(build_subscriber_id_list_short(ids)).body
+    end
+
+    private
+    def build_subscriber_id_list_short(ids)
+      {
+        subscriberIDListShort: {
+          item: ids.map do |id|
+            {subscriberID: id}
+          end
+        }
+      }
+    end
+
+    def build_subscriber_id_list(attributes)
+      {
+        subscriberIDList: {
+          item: attributes.map do |attr|
+            {subscriberID: attr[:id], listID: attr[:list_id]}
+          end
+        }
+      }
+    end
+
+    def build_subscriber_list(attributes)
+      attributes_array = attributes.map do |attributes_hsh|
+        {
+          listID: attributes_hsh[:list_id],
+          email: attributes_hsh[:email],
+          customFields: {
+            item: build_custom_fields_array(attributes_hsh[:custom_fields])
+          }
+        }
+      end
+      {subscriberList: {item: attributes_array}}
+    end
+
+    def build_custom_fields_array(custom_fields)
+      custom_fields.map do |custom_fields_hsh|
+        { customFieldID: custom_fields_hsh[:field_id],
+          customFieldValue: custom_fields_hsh[:field_value] }
+      end
+    end
+  end
+end

data/lib/cleverelements/version.rb

@@ -0,0 +1,3 @@
+module CleverElements
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: cleverelements
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Despark
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+description: The API works with the network protocol SOAP (Simple Object Access Protocol).
+  SOAP libraries can be found in many modern programming languages such as PHP, Python,
+  Java and C++. SOAP therefore provides a good basis for simple cross-language communication.
+  The basis for SOAP is the WSDL file, in which all functions and parameters of the
+  API are described. The WSDL file is provided in XML format and can be read by many
+  editors (e.g. Aptana). [More Info about our API](http://support.cleverelements.com/kb/api/)
+email:
+- contact@despark.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cleverelements.gemspec
+- lib/cleverelements.rb
+- lib/cleverelements/client.rb
+- lib/cleverelements/lists.rb
+- lib/cleverelements/resource.rb
+- lib/cleverelements/subscribers.rb
+- lib/cleverelements/version.rb
+homepage: http://www.cleverelements.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: 'A ruby gem to help you implement [Clever Elements''](http://www.cleverelements.com/,
+  ''Clever Elements'') API in your projects. Detailed API documentations can be found
+  here: [http://support.cleverelements.com/kb/api/](http://support.cleverelements.com/kb/api/,
+  ''View API docs'').'
+test_files: []