apsis-on-steroids 0.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "http2", ">= 0.0.15"
+gem "string-cases"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", "~> 1.8.4"
+end

data/Gemfile.lock

@@ -0,0 +1,35 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    http2 (0.0.15)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.8.0)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    string-cases (0.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  http2 (>= 0.0.15)
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  string-cases

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 kaspernj
+
+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.rdoc

@@ -0,0 +1,74 @@
+= apsis-on-steroids
+
+Library that implements the Apsis API in Ruby in regards to administrating subscribers and such for newsletters.
+
+== Examples
+
+=== Connecting
+
+  aos = ApsisOnSteroids.new(
+    :api_key => "[your api key]"
+  )
+
+=== Get a mailing list.
+
+  mlist = aos.mailing_list_by_name("test_list")
+
+=== Get a subscriber from a mailing list.
+
+  sub = mlist.subscriber_by_email("some@email.com")
+
+=== Create one or more subscribers in a mailing list.
+
+  mlist.create_subscribers(
+    [
+      {
+        :Email => "some@email.com",
+        :Name => "Some Name"
+      },{
+        :Email => "some_other@email.com",
+        :Name => "Some Name"
+      }
+    ]
+  )
+
+=== Get details about subscribers.
+
+  puts "Details: #{sub.details}"
+
+=== Update subscribers.
+
+  sub.update(:Email => "some_third@email.com")
+
+=== Remove subscriber from a mailing list.
+
+  mlist.remove_subscriber(sub)
+
+=== Get a list of subscribers from a mailing list.
+
+  list = mlist.subscribers
+  list.each do |sub|
+    # do something
+  end
+
+=== Get a total list of subscribers.
+
+  aos.subscribers do |sub|
+    # do something
+  end
+
+== Contributing to apsis-on-steroids
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 kaspernj. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "apsis-on-steroids"
+  gem.homepage = "http://github.com/kaspernj/apsis-on-steroids"
+  gem.license = "MIT"
+  gem.summary = %Q{A Ruby API for the Apsis mail service. }
+  gem.description = %Q{A Ruby API for the Apsis mail service. }
+  gem.email = "k@spernj.org"
+  gem.authors = ["kaspernj"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "apsis-on-steroids #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/apsis-on-steroids.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "apsis-on-steroids"
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["kaspernj"]
+  s.date = "2013-06-21"
+  s.description = "A Ruby API for the Apsis mail service. "
+  s.email = "k@spernj.org"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "apsis-on-steroids.gemspec",
+    "include/mailing_list.rb",
+    "include/sub_base.rb",
+    "include/subscriber.rb",
+    "lib/apsis-on-steroids.rb",
+    "spec/apsis-on-steroids_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/kaspernj/apsis-on-steroids"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "A Ruby API for the Apsis mail service."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<http2>, [">= 0.0.15"])
+      s.add_runtime_dependency(%q<string-cases>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+    else
+      s.add_dependency(%q<http2>, [">= 0.0.15"])
+      s.add_dependency(%q<string-cases>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    end
+  else
+    s.add_dependency(%q<http2>, [">= 0.0.15"])
+    s.add_dependency(%q<string-cases>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+  end
+end
+

data/include/mailing_list.rb

@@ -0,0 +1,39 @@
+class ApsisOnSteroids::MailingList < ApsisOnSteroids::SubBase
+  def create_subscribers(data)
+    aos.req_json("v1/subscribers/mailinglist/#{data(:id)}/queue", :post, :json => data)
+  end
+  
+  def subscribers
+    res = aos.req_json("v1/mailinglists/#{data(:id)}/subscribers/all", :post, :json => {
+      "AllDemographics" => true,
+      "FieldNames" => []
+    })
+    
+    url = URI.parse(res["Result"]["PollURL"])
+    
+    Timeout.timeout(30) do
+      loop do
+        sleep 0.5
+        res = aos.req_json(url.path)
+        
+        puts "Status res: #{res}"
+        
+        if res["State"] == "2"
+          break
+        end
+      end
+    end
+    
+    puts "Test: #{res}"
+    raise "Finish me!"
+  end
+  
+  def remove_subscriber(subscriber)
+    res = aos.req_json("v1/mailinglists/#{self.data(:id)}/subscriptions/#{subscriber.data(:id)}", :delete)
+    if res["Result"] == "Deleted"
+      return nil
+    else
+      raise "Unexpected result: '#{res["Result"]}'."
+    end
+  end
+end

data/include/sub_base.rb

@@ -0,0 +1,25 @@
+class ApsisOnSteroids::SubBase
+  def initialize(args)
+    @args = args
+    
+    @data = {}
+    @args[:data].each do |key, val|
+      @data[StringCases.camel_to_snake(key).to_sym] = val
+    end
+  end
+  
+  def aos
+    return @args[:aos]
+  end
+  
+  def data(name)
+    name = name.to_sym
+    return @data[name] if @data.key?(name)
+    raise "No such data: '#{name}'."
+  end
+  
+  def method_missing(name, *args, &blk)
+    return @data[name.to_sym] if @data && @data.key?(name.to_sym)
+    raise "No such method: '#{name}'."
+  end
+end

data/include/subscriber.rb

@@ -0,0 +1,49 @@
+class ApsisOnSteroids::Subscriber < ApsisOnSteroids::SubBase
+  # Fetches the details from the server and returns them.
+  def details
+    res = aos.req_json("v1/subscribers/id/#{data(:id)}")
+    
+    ret = {}
+    res["Result"].each do |key, val|
+      ret[key.to_sym] = val
+    end
+    
+    return ret
+  end
+  
+  # Returns true if the subscriber is active.
+  def active?
+    details = self.details
+    
+    if details[:pending]
+      return false
+    end
+    
+    return true
+  end
+  
+  # Update one or more details on the subscriber.
+  def update(data)
+    res = aos.req_json("v1/subscribers/queue", :post, :json => [
+      {
+        :Id => data(:id)
+      }.merge(data)
+    ])
+    
+    url = URI.parse(res["Result"]["PollURL"])
+    data = nil
+    
+    loop do
+      res = aos.req_json(url.path)
+      
+      if res["State"] == "2"
+        url_data = URI.parse(res["DataUrl"])
+        data = aos.req_json(url_data.path)
+        break
+      end
+    end
+    
+    raise data["FailedUpdatedSubscribers"].to_s if data["FailedUpdatedSubscribers"] && data["FailedUpdatedSubscribers"].any?
+    return nil
+  end
+end

data/lib/apsis-on-steroids.rb

@@ -0,0 +1,139 @@
+require "json"
+require "http2"
+require "string-cases"
+require "timeout"
+require "cgi"
+
+class ApsisOnSteroids
+  attr_reader :http
+  
+  def self.const_missing(name)
+    require "#{File.dirname(__FILE__)}/../include/#{::StringCases.camel_to_snake(name)}"
+    raise "Still not loaded: '#{name}'." unless ApsisOnSteroids.const_defined?(name)
+    return ApsisOnSteroids.const_get(name)
+  end
+  
+  def initialize(args)
+    @args = args
+    @http = Http2.new(
+      :host => "se.api.anpdm.com",
+      :port => 8443,
+      :ssl => true,
+      :follow_redirects => false,
+      :debug => args[:debug],
+      :extra_headers => {
+        "Accept" => "text/json, application/json"
+      },
+      :basic_auth => {
+        :user => @args[:api_key],
+        :passwd => ""
+      }
+    )
+    
+    if block_given?
+      begin
+        yield self
+      ensure
+        @http.destroy
+        @http = nil
+      end
+    end
+  end
+  
+  def mailing_lists
+    res = req_json("v1/mailinglists/1/10")
+    
+    ret = []
+    res["Result"]["Items"].each do |mlist|
+      ret << ApsisOnSteroids::MailingList.new(
+        :aos => self,
+        :data => mlist
+      )
+    end
+    
+    return ret
+  end
+  
+  def mailing_list_by_name(name)
+    self.mailing_lists.each do |mlist|
+      return mlist if name.to_s == mlist.name.to_s
+    end
+    
+    raise "Could not find mailing list by that name: '#{name}'."
+  end
+  
+  def subscribers
+    # Request a list of all subs.
+    res = req_json("v1/subscribers/all", :post, :json => {
+      "AllDemographics" => true,
+      "FieldNames" => []
+    })
+    
+    # Wait for the server to generate the list.
+    url = URI.parse(res["Result"]["PollURL"])
+    data = nil
+    
+    Timeout.timeout(30) do
+      loop do
+        sleep 0.5
+        res = req_json(url.path)
+        
+        if res["State"] == "2"
+          url_data = URI.parse(res["DataUrl"])
+          data = req_json(url_data.path)
+          break
+        end
+      end
+    end
+    
+    # Parse the list of subscribers.
+    ret = [] unless block_given?
+    
+    data.each do |sub_data|
+      sub = ApsisOnSteroids::Subscriber.new(
+        :aos => self,
+        :data => sub_data
+      )
+      
+      if block_given?
+        yield sub
+      else
+        ret << sub
+      end
+    end
+    
+    if block_given?
+      return nil
+    else
+      return ret
+    end
+  end
+  
+  def subscriber_by_email(email)
+    res = req_json("v1/subscribers/email/lookup/#{CGI.escape(email)}")
+    
+    sub = ApsisOnSteroids::Subscriber.new(
+      :aos => self,
+      :data => {
+        "Id" => res["Result"],
+        "Email" => email
+      }
+    )
+    
+    return sub
+  end
+  
+  def req_json(url, type = :get, method_args = {})
+    # Parse arguments, send and parse the result.
+    args = {:url => url}.merge(method_args)
+    http_res = @http.__send__(type, args)
+    res = JSON.parse(http_res.body)
+    
+    # Check for various kind of server errors and raise them as Ruby errors if present.
+    raise "Failed on server with code #{res["Code"]}: #{res["Message"]}" if res.is_a?(Hash) && res.key?("Code") && res["Code"] < 0
+    raise "Failed on server with state #{res["State"]} and name '#{res["StateName"]}': #{res["Message"]}" if res.is_a?(Hash) && res.key?("State") && res["State"].to_i < 0
+    
+    # Return the result.
+    return res
+  end
+end

data/spec/apsis-on-steroids_spec.rb

@@ -0,0 +1,63 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ApsisOnSteroids" do
+  it "can connect" do
+    $aos = ApsisOnSteroids.new(
+      :api_key => File.read("#{File.dirname(__FILE__)}/api_key.txt").strip,
+      :debug => false
+    )
+  end
+  
+  it "can get a mailing list" do
+    $mlist = $aos.mailing_list_by_name("kj")
+  end
+  
+  it "can create subscribers" do
+    $mlist.create_subscribers([{
+      "Email" => "kj@gfish.com",
+      "Name" => "Kasper Johansen"
+    }])
+  end
+  
+  it "can get subscribers and their details" do
+    $sub = $aos.subscriber_by_email("kj@gfish.com")
+    details = $sub.details
+    details.is_a?(Hash).should eql(true)
+    details.key?(:pending).should eql(true)
+  end
+  
+  it "can update subscribers" do
+    new_email = "kaspernj#{Time.now.to_f}@naoshi-dev.com"
+    $sub.update(:Email => new_email)
+    $sub.details[:Email].should eql(new_email)
+  end
+  
+  it "should not overwrite data when updating" do
+    addr = Time.now.to_f.to_s
+    $sub.update(:Address => addr)
+    
+    new_email = "kaspernj#{Time.now.to_f}@naoshi-dev.com"
+    $sub.update(:Email => new_email)
+    
+    $sub.details[:Address].should eql(addr)
+  end
+  
+  it "can remove subscribers from lists" do
+    $mlist.remove_subscriber($sub)
+  end
+  
+  it "can get lists of subscribers from lists" do
+    $mlist.subscribers do |sub|
+      puts "Subscriber: #{sub}"
+    end
+  end
+  
+  it "can validate if a subscriber is active or not" do
+    $sub.active?.should eql(true)
+  end
+  
+  it "can get a list of all subscribers" do
+    total_list = $aos.subscribers
+    total_list.is_a?(Array).should eql(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'apsis-on-steroids'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: apsis-on-steroids
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.0
+platform: ruby
+authors:
+- kaspernj
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.15
+  name: http2
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.15
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: string-cases
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  name: rspec
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  name: rdoc
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  name: bundler
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  name: jeweler
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: ! 'A Ruby API for the Apsis mail service. '
+email: k@spernj.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- apsis-on-steroids.gemspec
+- include/mailing_list.rb
+- include/sub_base.rb
+- include/subscriber.rb
+- lib/apsis-on-steroids.rb
+- spec/apsis-on-steroids_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/kaspernj/apsis-on-steroids
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: -1005707843598481402
+      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.23
+signing_key: 
+specification_version: 3
+summary: A Ruby API for the Apsis mail service.
+test_files: []