mailinabox-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9ca01f26c2c20182f374d54994b9cf30ecb14ad3920d2acf6d1d098fa7c4a4bc
+  data.tar.gz: '0537219dbb0d1cf1a4b9543facb2c6df3e2519ef640b6b5e85e1ea02606d38a0'
+SHA512:
+  metadata.gz: 0f5ef63f1baed49f143d6470edc7e0d5378a2a55542ff71c4f996336a58f9ae2853509d333d670941478e5aaaf8b80b9ec8a1adce7758197ed64e19ff129100c
+  data.tar.gz: 2b13039f9b47eb1733523ecfc5de9f21123ff646bebd040da6cac8029d4ff6aeb504f485c088118fbca5c22e8faab08022979d124687e0fa96f4f6ba296765ad

data/.gitignore

@@ -0,0 +1,25 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/tmp/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# pry history
+.pry_history
+
+# RVM
+.ruby-version
+.ruby-gemset
+
+# DS_Store
+.DS_Store
+
+# Credentials
+/config/credentials.yml

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 1.16.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sebastian.johnsson@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 mailinabox-api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    mailinabox-api (0.1.0)
+      faraday (~> 0.15.2)
+      faraday_middleware (~> 0.12.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    method_source (0.9.0)
+    multipart-post (2.0.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    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.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  mailinabox-api!
+  pry (~> 0.11.3)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sebastian
+
+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,67 @@
+# Mail-in-a-Box Ruby API
+
+Mailinabox::Api is a lighweight Ruby API client for interacting with [Mail-in-a-Box](https://mailinabox.email)'s API endpoints.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mailinabox-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mailinabox-api
+
+## Usage
+
+1. Configure the client using Mailinabox::Api.configure:
+
+```ruby
+  ::Mailinabox::Api.configure do |config|
+    config.host       =   "HOSTNAME" # Hostname including https://
+    config.user       =   "USER"     # Admin user email address
+    config.password   =   "PASSWORD" # Admin user password
+  end
+```
+
+2. Initialize the client:
+
+```ruby
+  client              =   Mailinabox::Api::Client.new
+```
+
+3. Invoke any of the available endpoints:
+
+* #users - get all users, you can specify domain: 'DOMAIN' to only returned a filtered list for a specific domain
+
+* #add_user(email:, password:) - create a new user. Note that password must be at least 8 characters.
+
+* #remove_user(email:) - remove a user
+
+* #add_user_privilege(email:, privilege: :admin) - add a user privilege
+
+* #remove_user_privilege(email:, privilege: :admin) - remove a user privilege
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/SebastianJ/mailinabox-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Mailinabox::Api project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/SebastianJ/mailinabox-api/blob/master/CODE_OF_CONDUCT.md).

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,16 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mailinabox/api"
+require_relative "../config/setup"
+
+# 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.config.history.file = File.join(__FILE__, "../.pry_history")
+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/config/credentials.yml.example

@@ -0,0 +1,4 @@
+# Copy this file to credentials.yml and insert your own host, user and password combination in order to use the console and run specs.
+host: "https://HOST"
+user: "admin@HOST"
+password: "PASSWORD"

data/config/setup.rb

@@ -0,0 +1,15 @@
+# This is just a helper file to configure the client from a credentials file
+
+require "yaml"
+
+cfg_path              =   File.join(File.dirname(__FILE__), "credentials.yml")
+
+if ::File.exists?(cfg_path)
+  cfg                 =   YAML.load_file(cfg_path)
+
+  ::Mailinabox::Api.configure do |config|
+    config.host       =   cfg.fetch("host", nil)
+    config.user       =   cfg.fetch("user", nil)
+    config.password   =   cfg.fetch("password", nil)
+  end
+end

data/lib/mailinabox/api.rb

@@ -0,0 +1,38 @@
+# Gems
+require "faraday"
+require "faraday_middleware"
+
+# Standard Lib
+require "json"
+
+require "mailinabox/api/version"
+
+require "mailinabox/api/constants"
+
+require "mailinabox/api/configuration"
+
+require "mailinabox/api/endpoints/users"
+
+require "mailinabox/api/client"
+
+module Mailinabox
+  module Api
+    
+    class << self
+      attr_writer :configuration
+    end
+  
+    def self.configuration
+      @configuration ||= ::Mailinabox::Api::Configuration.new
+    end
+
+    def self.reset
+      @configuration = ::Mailinabox::Api::Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+    
+  end
+end

data/lib/mailinabox/api/client.rb

@@ -0,0 +1,68 @@
+module Mailinabox
+  module Api
+    
+    class Client
+      attr_accessor :configuration, :connection
+    
+      def initialize(configuration: ::Mailinabox::Api.configuration)
+        self.configuration          =   configuration
+        self.init_connection
+      end
+    
+      include ::Mailinabox::Api::Endpoints::Users
+    
+      def init_connection(headers: {}, options: {})
+        headers["User-Agent"]       =   options.fetch(:user_agent, self.configuration.faraday.fetch(:user_agent, nil))
+      
+        self.connection           ||=   ::Faraday.new(url: self.configuration.host) do |builder|
+          builder.headers           =   headers
+          
+          builder.basic_auth(self.configuration.user, self.configuration.password)
+          
+          builder.request  :url_encoded
+          builder.response :logger      if self.configuration.verbose_faraday?
+          
+          builder.adapter self.configuration.faraday.fetch(:adapter, :net_http)
+        end
+      end
+
+      def get(path, params: {}, headers: {}, options: {})
+        request path, method: :get, params: params, headers: headers, options: options
+      end
+
+      def post(path, params: {}, data: {}, headers: {}, options: {})
+        request path, method: :post, params: params, data: data, headers: headers, options: options
+      end
+
+      def request(path, method: :get, params: {}, data: {}, headers: {}, options: {}, retries: 3)      
+        response              =   nil
+      
+        begin
+          response            =   case method
+            when :get, :head, :options
+              self.connection.send(method) do |request|
+                request.url path
+                request.params  =   params if params && !params.empty?
+              end
+            when :post, :put, :patch, :delete
+              self.connection.send(method) do |request|
+                request.url path
+                request.body    =   data if data && !data.empty?
+                request.params  =   params if params && !params.empty?
+              end
+          end
+        rescue Faraday::TimeoutError, Faraday::ConnectionFailed => e
+          retries -= 1
+          retry if retries > 0
+        end
+      
+        return response&.body
+      end
+      
+      def evaluate_response(method, response)
+        response&.to_s&.strip&.downcase&.eql?(Mailinabox::Api::Constants::RESPONSES[method])
+      end
+      
+    end
+  end
+end

data/lib/mailinabox/api/configuration.rb

@@ -0,0 +1,25 @@
+module Mailinabox
+  module Api
+    class Configuration
+      attr_accessor :host, :user, :password
+      attr_accessor :faraday
+    
+      def initialize
+        self.host             =   nil
+        self.user             =   nil
+        self.password         =   nil
+                
+        self.faraday          =   {
+          adapter:    :net_http,
+          user_agent: 'Mail-in-a-box Ruby API Client',
+          verbose:    true
+        }
+      end
+      
+      def verbose_faraday?
+        self.faraday.fetch(:verbose, false)
+      end
+    
+    end
+  end
+end

data/lib/mailinabox/api/constants.rb

@@ -0,0 +1,14 @@
+module Mailinabox
+  module Api
+    module Constants
+      
+      RESPONSES = {
+        add_user:               "mail user added",
+        remove_user:            "mail user removed",
+        add_user_privilege:     "ok",
+        remove_user_privilege:  "ok",
+      }
+      
+    end
+  end
+end

data/lib/mailinabox/api/endpoints/users.rb

@@ -0,0 +1,56 @@
+module Mailinabox
+  module Api
+    module Endpoints
+      module Users
+      
+        def users(domain: nil, options: {})
+          params      =   {
+            format: :json
+          }
+        
+          response    =   get("/admin/mail/users", params: params, options: options)
+          response    =   !response.to_s.empty? ? JSON.parse(response) : response
+          response    =   response.select { |data| data["domain"].eql?(domain) }.first if !domain.to_s.empty? && (response && response.is_a?(Array) && response.any?)
+          
+          return response
+        end
+        
+        def add_user(email:, password:, options: {})
+          data        =   {
+            email:      email,
+            password:   password,
+          }
+          
+          evaluate_response(__method__, post("/admin/mail/users/add", data: data, options: options))
+        end
+        
+        def remove_user(email:, options: {})
+          data        =   {
+            email:      email,
+          }
+          
+          evaluate_response(__method__, post("/admin/mail/users/remove", data: data, options: options))
+        end
+        
+        def add_user_privilege(email:, privilege: :admin, options: {})
+          data        =   {
+            email:      email,
+            privilege:  privilege,
+          }
+          
+          evaluate_response(__method__, post("/admin/mail/users/privileges/add", data: data, options: options))
+        end
+        
+        def remove_user_privilege(email:, privilege: :admin, options: {})
+          data        =   {
+            email:      email,
+            privilege:  privilege,
+          }
+          
+          evaluate_response(__method__, post("/admin/mail/users/privileges/remove", data: data, options: options))
+        end
+        
+      end
+    end
+  end
+end

data/lib/mailinabox/api/version.rb

@@ -0,0 +1,5 @@
+module Mailinabox
+  module Api
+    VERSION = "0.1.0"
+  end
+end

data/mailinabox-api.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mailinabox/api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mailinabox-api"
+  spec.version       = Mailinabox::Api::VERSION
+  spec.authors       = ["Sebastian"]
+  spec.email         = ["sebastian.johnsson@gmail.com"]
+
+  spec.summary       = %q{Mail-in-a-box Ruby API Client}
+  spec.description   = %q{Mail-in-a-box: Ruby API Client to interact with the API endpoints}
+  spec.homepage      = "https://github.com/SebastianJ/mailinabox-api"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency "faraday", "~> 0.15.2"
+  spec.add_dependency "faraday_middleware", "~> 0.12.2"
+
+  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 "pry", "~> 0.11.3"
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: mailinabox-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sebastian
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-18 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.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+description: 'Mail-in-a-box: Ruby API Client to interact with the API endpoints'
+email:
+- sebastian.johnsson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/credentials.yml.example
+- config/setup.rb
+- lib/mailinabox/api.rb
+- lib/mailinabox/api/client.rb
+- lib/mailinabox/api/configuration.rb
+- lib/mailinabox/api/constants.rb
+- lib/mailinabox/api/endpoints/users.rb
+- lib/mailinabox/api/version.rb
+- mailinabox-api.gemspec
+homepage: https://github.com/SebastianJ/mailinabox-api
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Mail-in-a-box Ruby API Client
+test_files: []