mailarchiva 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e653b0d7c3ce3d017ba0c755fd4aeb4046a0765
+  data.tar.gz: ed46e44af53c5c81b9f9f10d3b68cc3dda450568
+SHA512:
+  metadata.gz: a4882baa6b0a33b13c70b9a7e1e873252729c14ab0c052f3ab1906ebc1223008d88610eb39bd03c5bf31309dcf9c788870cff042c8ab63aa3e891f758bf41290
+  data.tar.gz: e883c4c776bd464959540a358c535b6885360d0425673afedb738a36098c3d35a50fea912a3a0135f4e55b861e47f56c5b373ec7a36dc50fc1bdad1ee20725fe

data/.document

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

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0"
+  gem "simplecov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 David John
+
+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,14 @@
+# mailarchiva
+
+A ruby gem to access the [Mailarchiva] API.  Refer to the [Mailarchiva API] for more info.
+
+```ruby
+require 'mailarchiva'
+mailarchiva = Mailarchiva::Client.new(host: '192.168.1.1', user: 'user', pass: 'pass')
+results = mailarchiva.search_by_subject('test') # An array of Mailarchiva::Message
+
+mailarchiva.get_message(results.first) # A Mail message
+```
+
+[Mailarchiva]:https://www.mailarchiva.com/
+[Mailarchiva API]:https://www.mailarchiva.com/help/display/MAIL/Web+Services+API

data/Rakefile

@@ -0,0 +1,53 @@
+# 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://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "mailarchiva"
+  gem.homepage = "http://github.com/billguy/mailarchiva"
+  gem.license = "MIT"
+  gem.summary = %Q{Access the Mailarchiva API}
+  gem.description = %Q{A gem to access the Mailarchiva API}
+  gem.email = "dj@dbjohn.com"
+  gem.authors = ["David John"]
+  # dependencies defined in Gemfile
+  gem.add_dependency 'savon', '~> 2.10'
+  gem.add_dependency 'mail', '~> 2.6'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mailarchiva #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/mailarchiva.rb

@@ -0,0 +1,32 @@
+# https://www.mailarchiva.com/help/display/MAIL/Web+Services+API
+
+require 'mailarchiva/rest_client'
+require 'mailarchiva/soap_client'
+
+module Mailarchiva
+
+  class Client
+
+    attr_accessor :client
+
+    def initialize(args)
+      args.reverse_merge!({client: :soap, ssl: false, port: 8090, app_name: 'ROOT'})
+      @client = args[:client] == :rest ? RestClient.new(args) : SoapClient.new(args)
+    end
+
+    # blob_category 'email'
+    # query 'subject:test'
+    # sort_field 'sentdate' | 'archivedate' | 'receiveddate'
+    # sort_order 'sentdate' | 'archivedate' | 'receiveddate'
+    # date_type 'sentdate' | 'archivedate' | 'receiveddate'
+    # sent_before "2015-06-20T14:57:27" | Time object
+    # sent_after "2015-06-20T14:57:27" | Time object
+    # max_results 1000
+    def search_by_subject(subject, params={})
+      params.reverse_merge!({query: "subject:#{subject}"})
+      @client.search(params)
+    end
+
+  end
+
+end

data/lib/mailarchiva/base.rb

@@ -0,0 +1,17 @@
+require "base64"
+require "mail"
+
+module Mailarchiva
+
+  class Base
+
+    attr_accessor :host, :user, :pass, :ssl, :port, :app_name, :client
+
+    def initialize(args)
+      args.each do |k,v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+  end
+
+end

data/lib/mailarchiva/message.rb

@@ -0,0 +1,26 @@
+module Mailarchiva
+
+  class Message
+
+    attr_accessor :blob_id, :volume_id, :size, :sentdate, :receiveddate, :archivedate, :from, :to, :subject, :cc, :bcc, :deliveredto, :messageid, :rcptto, :mailfrom
+
+    def initialize(field_values)
+      field_values[:field_values].each do |field|
+        key = field[:field]
+        value = field[:value]
+        case key
+          when /date/
+            value = DateTime.parse(value) if value
+          when /size/
+            value = value.to_i if value
+          else
+            value
+        end
+        instance_variable_set("@#{key}", value) if respond_to?(key.to_sym)
+      end
+      @blob_id = field_values[:id][:blob_id]
+      @volume_id = field_values[:id][:volume_id]
+    end
+
+  end
+end

data/lib/mailarchiva/rest_client.rb

@@ -0,0 +1,39 @@
+require 'mailarchiva/base'
+
+module Mailarchiva
+
+  class RestClient < Base
+
+    def initialize(args)
+      super(args)
+      raise "RestClient is not supported yet b/c it does not work on Mailarchiva as of 4.5.8"
+    end
+
+    def search(params={})
+      response = @client.get api, params
+      parsed_response = JSON.parse(response.body, symbolize_names: true)
+      parsed_response[:results]
+      parsed_response.map{|field_values| Message.new(field_values)}
+    end
+
+    def api
+      "/archiva3/api/blob"
+    end
+
+    def self.client(host, user, pass, ssl, port, app_name)
+      connection = Faraday.new(url: url(ssl, host, port))
+      connection.headers = {'Authorization' => basic_auth(app_name, user, pass), 'Accept' => 'application/json'}
+      connection
+    end
+
+    def self.basic_auth(app_name, user, pass)
+      Base64.strict_encode64("#{app_name}:#{user}:#{pass}")
+    end
+
+    def self.url(ssl, host, port)
+      "%s://%s:%s" % [ssl ? 'https' : 'http', host, port]
+    end
+
+  end
+
+end

data/lib/mailarchiva/soap_client.rb

@@ -0,0 +1,73 @@
+require 'mailarchiva/base'
+require 'mailarchiva/message'
+require 'savon'
+
+module Mailarchiva
+
+  class SoapClient < Base
+
+    HTTPI.adapter = :net_http
+
+    attr_accessor :soap_client
+
+    def initialize(args)
+      super(args)
+    end
+
+    def search(params={})
+      params.reverse_merge!({blob_category: 'email', max_results: 1000})
+      params[:sent_before] = params[:sent_before].strftime("%Y-%m-%dT%T") if params.has_key?(:sent_before) && params[:sent_before].is_a?(Time)
+      params[:sent_after] = params[:sent_after].strftime("%Y-%m-%dT%T") if params.has_key?(:sent_after) && params[:sent_after].is_a?(Time)
+      search_response = soap_client.call(:search, message: params)
+      search_results = search_results_from_response(search_response)
+      logout
+      search_results
+    end
+
+    def search_results_from_response(response)
+      return [] if search_result_size == 0
+      search_results_response = soap_client.call(:get_search_results, message: { blob_category: 'email', start: 1, end: search_result_size })
+      search_results = search_results_response.body[:get_search_results_response][:return]
+      search_results.map{|field_values| Message.new(field_values)}
+    end
+
+    def search_result_size
+      search_result_size_response = soap_client.call(:get_search_result_size)
+      search_result_size_response.body[:get_search_result_size_response][:return].to_i
+    end
+
+    def get_message(blob_id, volume_id)
+      blob_response = soap_client.call(:get_blob, message: { 'blobID' =>{ 'blobID' => blob_id, 'volumeID' => volume_id } })
+      encoded_message = blob_response.body[:get_blob_response][:return][:blob]
+      decoded_message = Base64.decode64(encoded_message)
+      Mail.new(decoded_message)
+    end
+
+    def wsdl
+      "%s://%s:%s/services/search?wsdl" % [ssl ? 'https' : 'http', host, port]
+    end
+
+    def soap_client
+      @soap_client ||= begin
+        auth_cookies = login(Savon.client(wsdl: wsdl))
+        Savon.client(wsdl: wsdl, headers: { 'Cookie' => auth_cookies.to_s})
+      end
+    end
+
+    def login(client)
+      response = client.call(:login, message: { applicationname: @app_name, username: @user, password: @pass })
+      response.http.cookies.first.name_and_value
+    end
+
+    def logged_in?
+      @session_id.nil? ? false : soap_client.call(:is_logged_in).body[:is_logged_in_response][:return]
+    end
+
+    def logout
+      soap_client.call(:logout, message: {})
+      @soap_client = nil
+    end
+
+  end
+
+end

data/lib/mailarchiva/version.rb

@@ -0,0 +1,10 @@
+class Mailarchiva
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 0
+    BUILD = ''
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+end

data/mailarchiva.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: mailarchiva 0.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "mailarchiva"
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["David John"]
+  s.date = "2015-06-22"
+  s.description = "A gem to access the Mailarchiva API"
+  s.email = "dj@dbjohn.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/mailarchiva.rb",
+    "lib/mailarchiva/base.rb",
+    "lib/mailarchiva/message.rb",
+    "lib/mailarchiva/rest_client.rb",
+    "lib/mailarchiva/soap_client.rb",
+    "lib/mailarchiva/version.rb",
+    "mailarchiva.gemspec",
+    "test/helper.rb",
+    "test/test_mailarchiva.rb"
+  ]
+  s.homepage = "http://github.com/billguy/mailarchiva"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.2"
+  s.summary = "Access the Mailarchiva API"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_runtime_dependency(%q<savon>, ["~> 2.10"])
+      s.add_runtime_dependency(%q<mail>, ["~> 2.6"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<savon>, ["~> 2.10"])
+      s.add_dependency(%q<mail>, ["~> 2.6"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<savon>, ["~> 2.10"])
+    s.add_dependency(%q<mail>, ["~> 2.6"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,34 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_adapter 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'mailarchiva'
+
+class Test::Unit::TestCase
+end

data/test/test_mailarchiva.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestMailarchiva < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: mailarchiva
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- David John
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: A gem to access the Mailarchiva API
+email: dj@dbjohn.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/mailarchiva.rb
+- lib/mailarchiva/base.rb
+- lib/mailarchiva/message.rb
+- lib/mailarchiva/rest_client.rb
+- lib/mailarchiva/soap_client.rb
+- lib/mailarchiva/version.rb
+- mailarchiva.gemspec
+- test/helper.rb
+- test/test_mailarchiva.rb
+homepage: http://github.com/billguy/mailarchiva
+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: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Access the Mailarchiva API
+test_files: []