oma-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f0bd40530f84539309649bc84ab16f8d5ccba77
+  data.tar.gz: baba61dd76d77128dbab50d882f6f780b502d5c8
+SHA512:
+  metadata.gz: d9051716cd3aad70618183d316a3bc3a8c1f8504239f1b6820e75715214ce2975837377906c15dfca780afa919706355832eea91c550efccd3f382cedbc18a30
+  data.tar.gz: daca8c5674093fb4397b9997b2939939474d0fcd2007d4d2659e3ecfa6222f4603fbd2bea3f46e78aa7f3bd0f5c0ce64fdbd91b9c287a6b35fbe5b245f2d0de4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in oma.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    oma-ruby (0.1.0)
+      faraday (~> 0.15)
+      faraday_middleware (~> 0.12)
+      oj (~> 3.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    multipart-post (2.0.0)
+    oj (3.7.1)
+    public_suffix (3.0.3)
+    rake (10.4.2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    safe_yaml (1.0.4)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  oma-ruby!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock (~> 1.20)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 ousmane
+
+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,39 @@
+# Oma Ruby
+The Oma Ruby library provides convenient access to the Open SRS Mail API from applications written in the Ruby language.
+
+See the [OpenSRS Mail  API](https://opensrs.com/wp-content/uploads/OpenSRS_Mail_API.pdf).
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oma-ruby'
+```
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oma-ruby
+
+## Requirements
+* Ruby 2.0+.
+
+## Usage
+
+```ruby
+require 'oma-ruby'
+
+oma_client = Oma::Ruby::Client.new(
+  url:      'https://mail.test.hostedemail.com/api',
+  user:     'admin@companydomain.com',
+  password: 'company_password'
+)
+
+oma_client.change_user(
+  user: 'john@example.com',
+  password: 'p@ssword',
+  name: 'John Doe'
+)
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "oma"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/oma-ruby/actions.rb

@@ -0,0 +1,57 @@
+module Oma
+  module Ruby
+    module Actions
+      API_ACTIONS = %w[
+        authenticate
+        change_company
+        change_company_bulletin
+        echo
+        get_company
+        get_company_bulletin
+        get_company_changes
+        post_company_bulletin
+        search_admins
+        change_domain
+        change_domain_bulletin
+        delete_domain
+        get_domain
+        get_domain_bulletin
+        get_domain_changes
+        post_domain_bulletin
+        restore_domain
+        search_domains
+        create_workgroup
+        delete_workgroup
+        search_workgroups
+        change_user
+        delete_user
+        generate_token
+        get_deleted_contacts
+        get_deleted_messages
+        get_user
+        get_user_attribute_history
+        get_user_changes
+        get_user_folders
+        get_user_messages
+        logout_user
+        move_user_messages
+        reindex
+        rename_user
+        restore_deleted_contacts
+        restore_deleted_messages
+        restore_user
+        search_users
+        set_role
+        user_notify
+        search_brands
+        stats_list
+        stats_snapshot
+        stats_summary
+        migration_add
+        migration_jobs
+        migration_status
+        migration_trace
+      ].freeze
+    end
+  end
+end

data/lib/oma-ruby/client.rb

@@ -0,0 +1,72 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'oj'
+
+module Oma
+  # Client implementation
+  module Ruby
+    # Client class
+    class Client
+      attr_reader :url, :user, :password
+
+      include Errors
+      include Actions
+
+      def initialize(url:, user:, password:)
+        @url      = url
+        @user     = user
+        @password = password
+      end
+
+      API_ACTIONS.each do |action|
+        define_method(action) do |params = nil|
+          request(action, params || {})
+        end
+      end
+
+      private
+
+      def api
+        @api ||= Faraday.new(url: url) do |connection|
+          connection.request :json
+          connection.adapter Faraday.default_adapter
+        end
+      end
+
+      def request(action, params)
+        response = api.post(action, format_params(params))
+
+        handle_reponse(response)
+      end
+
+      def handle_reponse(response)
+        check_http_error!(response)
+        check_api_error!(response)
+
+        Oj.load(response.body)
+      end
+
+      def check_http_error!(response)
+        return if response.status == 200
+
+        raise http_error(response.status)
+      end
+
+      def check_api_error!(response)
+        body = Oj.load(response.body)
+
+        return if body['success']
+
+        raise api_error(body['error_number']), body['error']
+      end
+
+      def api_credentials
+        @api_credentials ||= { user: user, password: password }
+      end
+
+      def format_params(params)
+        { credentials: api_credentials }.merge(params)
+      end
+    end
+  end
+end

data/lib/oma-ruby/errors.rb

@@ -0,0 +1,56 @@
+module Oma
+  # HTTP and API Errors mapping
+  module Ruby
+    # Errors module
+    module Errors
+      class HttpError < StandardError; end
+      class OpenSRSApiError < StandardError; end
+
+      HTTP_ERRORS = {
+        '400' => 'BadRequestError',
+        '404' => 'NotFoundError',
+        '500' => 'InternalServerError'
+      }.freeze
+
+      API_ERRORS = {
+        '0'  => 'ServerError',
+        '1'  => 'InvalidCredentialsError',
+        '2'  => 'RequestedObjectDoesNotExistError',
+        '3'  => 'ObjectIsAliasError',
+        '4'  => 'RequestorLacksPermissionError',
+        '5'  => 'RequestBadlyFormattedError',
+        '6'  => 'AttributesBadlyFormattedError',
+        '7'  => 'ObjectAlreadyExistsError',
+        '8'  => 'DomainDoesNotExistError',
+        '9'  => 'RequestorDoesNotOwnObjectError',
+        '10' => 'RequestedObjectNotEmptyError',
+        '11' => 'CompanyDoesNotExistError',
+        '12' => 'RoleDoesNotExistError',
+        '13' => 'UserDoesNotExistError',
+        '14' => 'BrandInUseError',
+        '15' => 'DomainUsersFullError',
+        '16' => 'DomainAliasesFullError',
+        '17' => 'NotInError',
+        '18' => 'WorkgroupIsDefaultError',
+        '19' => 'MigrationJobExistsError',
+        '20' => 'TryAgainLaterError'
+      }.freeze
+
+      HTTP_ERRORS.each_value do |error|
+        const_set(error, Class.new(HttpError))
+      end
+
+      API_ERRORS.each_value do |error|
+        const_set(error, Class.new(OpenSRSApiError))
+      end
+
+      def http_error(status)
+        Oma::Ruby::Errors.const_get(HTTP_ERRORS.fetch(status.to_s, 'HttpError'))
+      end
+
+      def api_error(code)
+        Oma::Ruby::Errors.const_get(API_ERRORS.fetch(code.to_s, 'OpenSRSApiError'))
+      end
+    end
+  end
+end

data/lib/oma-ruby/version.rb

@@ -0,0 +1,5 @@
+module Oma
+  module Ruby
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/oma-ruby.rb

@@ -0,0 +1,10 @@
+require 'oma-ruby/version'
+require 'oma-ruby/errors'
+require 'oma-ruby/actions'
+require 'oma-ruby/client'
+
+module Oma
+  # Main module
+  module Ruby
+  end
+end

data/oma-ruby.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "oma-ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "oma-ruby"
+  spec.version       = Oma::Ruby::VERSION
+  spec.authors       = ["Rahmane Ousmane"]
+  spec.email         = ["ousmanedev@gmail.com"]
+
+  spec.summary       = %q{OpenSrs Mail API}
+  spec.description   = %q{Ruby Gem to utilize the OpenSRS MAIL API}
+  spec.homepage      = "https://github.com/ousmanedev/oma"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "faraday",  "~> 0.15"
+  spec.add_runtime_dependency "faraday_middleware", "~> 0.12"
+  spec.add_runtime_dependency "oj", "~> 3.7"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 1.20"
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: oma-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rahmane Ousmane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+description: Ruby Gem to utilize the OpenSRS MAIL API
+email:
+- ousmanedev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/oma-ruby.rb
+- lib/oma-ruby/actions.rb
+- lib/oma-ruby/client.rb
+- lib/oma-ruby/errors.rb
+- lib/oma-ruby/version.rb
+- oma-ruby.gemspec
+homepage: https://github.com/ousmanedev/oma
+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.5
+signing_key: 
+specification_version: 4
+summary: OpenSrs Mail API
+test_files: []