mailflow-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 73f1f3042f8801bba568a43951114904f8c6f287
+  data.tar.gz: b6ed8ff54bedf61f2d734a92aa1116529bd274a2
+SHA512:
+  metadata.gz: 42f2caa96efd688b31de2e0d202a0ef01328f9ab8fde1a5c68b4af96017870bed26dcd27606b00deee96e576e110d40880f6d648ddddae17174f6d1db76a7972
+  data.tar.gz: ee3a1999bfdde6f07b03c26c258f5f4be8d088eb4630f4d5fdb5c0548f8ac5c826f2ff3773ef7a112dbf8b53a5a5fb11030c94e9cff2a9256a8b57a993d9864c

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TODO: Write your name
+
+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,3 @@
+### TODO
+
+* Write a readme

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 "mailflow-ruby"
+
+# 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/lib/mailflow-ruby/api_operations.rb

@@ -0,0 +1,38 @@
+require 'httparty'
+require 'byebug'
+
+module Mailflow
+  module APIOperations
+    module ClassMethods
+
+      def url(endpoint)
+        "https://mailflow.com/api/#{endpoint}"
+      end
+
+      def get_request(endpoint, params = {})
+        options = base_params.merge({query: params})
+        HTTParty.get(url(endpoint), options)
+      end
+
+      def post_request(endpoint, params = {})
+        options = base_params.merge({ body: params.to_json, headers: { "Content-Type" => "application/json", 'Accept'=>'application/json'} })
+        HTTParty.post(url(endpoint), options)
+      end
+
+      def delete_request(endpoint, params = {})
+        options = base_params.merge({ body: params.to_json, headers: { "Content-Type" => "application/json", 'Accept'=>'application/json'} })
+        HTTParty.delete(url(endpoint), options)
+      end
+
+      def base_params
+        (Mailflow.test_mode) ? {} : {digest_auth: {username: Mailflow.config.api_key, password: Mailflow.config.api_secret}}
+      end
+
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+  end
+end

data/lib/mailflow-ruby/attribute.rb

@@ -0,0 +1,49 @@
+module Mailflow
+
+  class UnprocessableError < StandardError; end
+
+  class Attribute
+
+    include Mailflow::APIOperations
+
+    attr_accessor :name
+
+    class << self
+      def list(options = {})
+        response = get_request('attributes', options)
+        response.parsed_response.map do |params|
+          Attribute.new(params)
+        end
+      end
+
+      def update(attributes, params)
+        body = {attributes: attributes}.merge(params)
+        response = post_request('attributes', body)
+        raise UnprocessableError if (response.code == 422 || response.code == 404)
+        response.parsed_response.map do |attributes|
+          Attribute.new(attributes)
+        end
+      end
+
+      def delete(attributes, params = {})
+        body = {attributes: attributes}.merge(params)
+        response = delete_request('attributes', body)
+        raise UnprocessableError if (response.code == 422 || response.code == 404)
+        return true
+      end
+
+    end
+
+    def initialize(attributes)
+      @key = attributes["key"]
+      @label = attributes["label"]
+      @value = attributes["value"]
+    end
+
+    def ==(other)
+      self.name == other.name
+    end
+
+  end
+
+end

data/lib/mailflow-ruby/client.rb

@@ -0,0 +1,22 @@
+require 'base64'
+require 'json'
+require 'httparty'
+require 'byebug'
+
+module Mailflow
+
+  class << self
+    attr_accessor :test_mode
+  end
+  
+  class Client
+
+    include Mailflow::APIOperations
+
+    def self.test
+      get('test')
+    end
+
+  end
+
+end

data/lib/mailflow-ruby/configurable.rb

@@ -0,0 +1,32 @@
+require 'hashie'
+
+module Configurable
+  def self.included(base)
+    base.const_set(:Configuration, Class.new(Hashie::Mash))
+    base.extend(ClassMethods)
+  end
+
+  protected
+
+  module ClassMethods
+    def configuration_class
+      self.const_get(:Configuration)
+    end
+
+    def configuration
+      @configuration ||= configuration_class.new
+    end
+
+    def configuration=(configuration)
+      @configuration = configuration_class.new(configuration)
+    end
+
+    alias_method :config, :configuration
+
+    def configure(configuration = {}, &block)
+      self.configuration = configuration unless configuration.empty?
+      block.call(self.configuration) if block_given?
+    end
+
+  end
+end

data/lib/mailflow-ruby/contact.rb

@@ -0,0 +1,74 @@
+module Mailflow
+
+  class UnprocessableError < StandardError; end
+
+  class Contact
+
+    include Mailflow::APIOperations
+
+    attr_accessor :id, :email, :created_at, :confirmed
+
+    class << self
+      def list
+        response = get_request('contacts')
+        response.parsed_response.map do |attributes|
+          Contact.new(attributes)
+        end
+      end
+
+      def get(options = {})
+        response = get_request('contacts', options)
+        Contact.new(response.parsed_response) if response.code == 200
+      end
+
+      def create(attributes)
+        response = post_request('contacts', attributes)
+        raise UnprocessableError if (response.code == 422 || response.code == 404)
+        Contact.new(response.parsed_response)
+      end
+    end
+
+    def initialize(attributes)
+      @id = attributes["id"]
+      @email = attributes["email"]
+      @created_at = attributes["created_at"]
+      @confirmed = attributes["confirmed"]
+    end
+
+    def ==(other)
+      self.id == other.id &&
+      self.email == other.email &&
+      self.confirmed == other.confirmed
+    end
+
+    def delete
+      Mailflow::Contact.delete_request('contacts', {contact_id: id}).parsed_response
+    end
+
+    def tags
+      Mailflow::Tag.list(contact_id: id)
+    end
+
+    def tag(tags)
+      Mailflow::Tag.create(tags, {contact_id: id})
+    end
+
+    def untag(tags)
+      Mailflow::Tag.untag(tags, {contact_id: id})
+    end
+
+    def attributes
+      Mailflow::Attribute.list(contact_id: id)
+    end
+
+    def set_attributes(attributes)
+      attributes = attributes.map do |key, value|
+        {key: key.to_s, value: value}
+      end
+
+      Mailflow::Attribute.update(attributes, {contact_id: id})
+    end
+
+  end
+
+end

data/lib/mailflow-ruby/tag.rb

@@ -0,0 +1,54 @@
+module Mailflow
+
+  class UnprocessableError < StandardError; end
+
+  class Tag
+
+    include Mailflow::APIOperations
+
+    attr_accessor :name
+
+    class << self
+      def list(options = {})
+        response = get_request('tags', options)
+        response.parsed_response.map do |attributes|
+          Tag.new(attributes)
+        end
+      end
+
+      def create(tags, params = {}, trigger = false)
+        tags = tags.map { |tag| {name: tag}}
+        body = {tags: tags}
+        body.merge!(params)
+        body.merge!({trigger: trigger}) if trigger
+        
+        response = post_request('tags', body)
+        raise UnprocessableError if (response.code == 422 || response.code == 404)
+        response.parsed_response.map do |attributes|
+          Tag.new(attributes)
+        end
+      end
+
+      def untag(tags, params = {})
+        tags = tags.map { |tag| {name: tag}}
+        delete_request('tags', {tags: tags}.merge(params))
+      end
+
+    end
+
+    def initialize(attributes)
+      @name = attributes["name"]
+    end
+
+    def ==(other)
+      self.name == other.name
+    end
+
+    def delete
+      Mailflow::Tag.delete_request('tags', {tags: [{name: name}]})
+      return true
+    end
+
+  end
+
+end

data/lib/mailflow-ruby/version.rb

@@ -0,0 +1,3 @@
+module Mailflow
+  VERSION = '0.1.0'
+end

data/lib/mailflow-ruby.rb

@@ -0,0 +1,17 @@
+require "mailflow-ruby/configurable.rb"
+require "mailflow-ruby/api_operations.rb"
+require "mailflow-ruby/contact.rb"
+require "mailflow-ruby/attribute.rb"
+require "mailflow-ruby/tag.rb"
+require "mailflow-ruby/client.rb"
+require "mailflow-ruby/version.rb"
+
+module Mailflow
+
+  include Configurable
+
+  def self.setup(api_key, api_secret)
+    Mailflow.configure({api_key: api_key, api_secret: api_secret})
+  end
+
+end

data/mailflow-ruby.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mailflow-ruby/version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mailflow-ruby"
+  spec.version       = Mailflow::VERSION
+  spec.authors       = ["Chris Wickett", "Alex Rowan"]
+  spec.email         = ["admin@mailflow.com"]
+
+  spec.summary       = "Mailflow's Ruby API Wrapper"
+  spec.homepage      = "https://mailflow.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"]
+
+  # Gems for production
+  spec.add_dependency "httparty"
+  spec.add_dependency "hashie"
+  
+  # Gems for dev
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "byebug"
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: mailflow-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Wickett
+- Alex Rowan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 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: webmock
+  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: byebug
+  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'
+description: 
+email:
+- admin@mailflow.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mailflow-ruby.rb
+- lib/mailflow-ruby/api_operations.rb
+- lib/mailflow-ruby/attribute.rb
+- lib/mailflow-ruby/client.rb
+- lib/mailflow-ruby/configurable.rb
+- lib/mailflow-ruby/contact.rb
+- lib/mailflow-ruby/tag.rb
+- lib/mailflow-ruby/version.rb
+- mailflow-ruby.gemspec
+homepage: https://mailflow.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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Mailflow's Ruby API Wrapper
+test_files: []