mailerlite 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: efd9c3192e8b0b5803b0e38ad265b850315cc347
+  data.tar.gz: dbd161446be6234bd65db1eda6c06cea96d8dcfc
+SHA512:
+  metadata.gz: 5bdacde3271be3b651fdb21a664585f3b4fc2d33cb2bc59899fcdb7b777784768956710c9d42ed53d2019645ebd264740694e12b14ee914e7ecefc8d6dd82bff
+  data.tar.gz: e26de30288431b82a8c099ac20428db695947420b878ea1a72c799be73cf68f8ed4646b4d7ec46c314e7ba6d921eb04a80c5c565ccc4a73573a6f0de9c6fe596

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,25 @@
+sudo: false
+
+before_install:
+  - gem install bundler
+
+bundler_args: --without development
+
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+  - rbx
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+group :development, :test do
+  gem 'pry'
+end
+
+group :test do
+  gem 'codeclimate-test-reporter', require: false
+  gem 'coveralls',    '~> 0.8.13', require: false
+  gem 'guard-rspec',  '~> 4.6.5'
+  gem 'simplecov',    '~> 0.11.2', require: false
+  gem 'webmock',      '~> 1.24.3'
+end
+
+gemspec

data/README.md

@@ -0,0 +1,52 @@
+# MailerLite API Ruby wrapper
+
+A Ruby gem which helps to communicate with [MailerLite][mailerlite] API.
+
+[![Gem Version](http://img.shields.io/gem/v/mailerlite.svg?style=flat-square)][rubygems]
+[![Build Status](http://img.shields.io/travis/jpalumickas/mailerlite-ruby.svg?style=flat-square)][travis]
+[![Dependency Status](http://img.shields.io/gemnasium/jpalumickas/mailerlite-ruby.svg?style=flat-square)][gemnasium]
+[![Coverage Status](http://img.shields.io/coveralls/jpalumickas/mailerlite-ruby/master.svg?style=flat-square)][coveralls]
+[![Code Climate](http://img.shields.io/codeclimate/github/jpalumickas/mailerlite-ruby.svg?style=flat-square)][codeclimate]
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mailerlite'
+```
+
+## Usage
+
+### Authentication
+
+```ruby
+client = MailerLite::Client.new(api_key: 'my-secret-api-key')
+```
+
+Or create file under `config/initializers/mailerlite.rb`
+
+```ruby
+MailerLite.configure do |config|
+  config.api_key = 'my-secret-api-key'
+end
+```
+
+## Supported Ruby Versions
+
+This library aims to support and is [tested against][travis] the following Ruby
+implementations:
+
+* Ruby 1.9.3
+* Ruby 2.0.0
+* Ruby 2.1.0
+* Ruby 2.2.0
+* Ruby 2.3.0
+
+[rubygems]: https://rubygems.org/gems/mailerlite
+[travis]: http://travis-ci.org/jpalumickas/mailerlite-ruby
+[gemnasium]: https://gemnasium.com/jpalumickas/mailerlite-ruby
+[coveralls]: https://coveralls.io/r/jpalumickas/mailerlite-ruby
+[codeclimate]: https://codeclimate.com/github/jpalumickas/mailerlite-ruby
+
+[mailerlite]: https://www.mailerlite.com

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 "mailerlite"
+
+# 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,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/mailerlite/client.rb

@@ -0,0 +1,27 @@
+require 'mailerlite/connection'
+require 'mailerlite/configuration'
+
+require 'mailerlite/clients/lists'
+
+module MailerLite
+  class Client
+    include MailerLite::Clients::Lists
+
+    def initialize(options = {})
+      config.api_key = options[:api_key] if options[:api_key]
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield(config) if block_given?
+      true
+    end
+
+    def connection
+      @connection ||= Connection.new(self)
+    end
+  end
+end

data/lib/mailerlite/clients/lists.rb

@@ -0,0 +1,37 @@
+module MailerLite
+  module Clients
+    module Lists
+      def lists(options = {})
+        connection.get('lists/', options)
+      end
+
+      def list(id)
+        connection.get("lists/#{id}/")
+      end
+
+      def create_list(name)
+        connection.post('lists/', name: name)
+      end
+
+      def update_list(id, name)
+        connection.post("lists/#{id}/", name: name)
+      end
+
+      def delete_list(id)
+        connection.delete("lists/#{id}/")
+      end
+
+      def list_active_subscribers(id, options = {})
+        connection.get("lists/#{id}/active/", options)
+      end
+
+      def list_unsubscribed_subscribers(id, options = {})
+        connection.get("lists/#{id}/unsubscribed/", options)
+      end
+
+      def list_bounced_subscribers(id, options = {})
+        connection.get("lists/#{id}/bounced/", options)
+      end
+    end
+  end
+end

data/lib/mailerlite/configuration.rb

@@ -0,0 +1,21 @@
+require 'faraday_middleware'
+
+module MailerLite
+  class Configuration
+    # Default API endpoint
+    API_ENDPOINT = 'https://app.mailerlite.com/api/v1'.freeze
+
+    # Default User Agent header string
+    USER_AGENT = "MailerLite Ruby v#{MailerLite::VERSION}".freeze
+
+    attr_accessor :api_key
+
+    def url
+      API_ENDPOINT
+    end
+
+    def user_agent
+      USER_AGENT
+    end
+  end
+end

data/lib/mailerlite/connection.rb

@@ -0,0 +1,71 @@
+require 'faraday'
+require 'json'
+
+require 'mailerlite/middleware/raise_error'
+require 'mailerlite/middleware/underscore_keys'
+
+module MailerLite
+  class Connection
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def get(path, options = {})
+      request(:get, path, options).body
+    end
+
+    def delete(path, options = {})
+      request(:delete, path, options).body
+    end
+
+    def post(path, options = {})
+      options['apiKey'] = client.config.api_key
+
+      response = connection.post do |req|
+        req.url(path)
+        req.headers['Content-Type'] = 'application/json'
+        req.body = options.to_json
+      end
+
+      response.body
+    end
+
+    private
+
+    def request(method, path, options = {})
+      options['apiKey'] = client.config.api_key
+
+      response = connection.send(method) do |request|
+        request.url(path, options)
+      end
+
+      response
+    end
+
+    def connection
+      conn_opts = {
+        headers: { user_agent: client.config.user_agent },
+        url: client.config.url,
+        builder: middleware
+      }
+
+      Faraday.new(conn_opts)
+    end
+
+    def middleware
+      @middleware ||= Faraday::RackBuilder.new do |builder|
+        builder.request :json
+
+        builder.use FaradayMiddleware::FollowRedirects
+        builder.use FaradayMiddleware::Mashify
+        builder.use MailerLite::Middleware::UnderscoreKeys
+        builder.use FaradayMiddleware::ParseJson
+        builder.use MailerLite::Middleware::RaiseError
+
+        builder.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/mailerlite/core_ext/string.rb

@@ -0,0 +1,9 @@
+class String
+  def underscore
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+end

data/lib/mailerlite/error.rb

@@ -0,0 +1,42 @@
+module MailerLite
+  class Error < StandardError
+    # Returns the appropriate MailerLite::Error sublcass based
+    # on status and response message.
+    #
+    # response - The Hash of HTTP response.
+    #
+    # Returns the MailerLite::Error.
+    def self.from_response(response)
+      status = response[:status].to_i
+
+      klass = case status
+              when 400 then MailerLite::BadRequest
+              when 401 then MailerLite::Unauthorized
+              when 404 then MailerLite::NotFound
+              end
+
+      klass.new if klass
+    end
+  end
+
+  # Raised when MailerLite returns a 400 HTTP status code
+  class BadRequest < Error
+    def to_s
+      'Missing a required parameter or calling invalid method'
+    end
+  end
+
+  # Raised when MailerLite returns a 401 HTTP status code
+  class Unauthorized < Error
+    def to_s
+      'Invalid API key provided'
+    end
+  end
+
+  # Raised when MailerLite returns a 404 HTTP status code
+  class NotFound < Error
+    def to_s
+      "Can't find requested items"
+    end
+  end
+end

data/lib/mailerlite/middleware/raise_error.rb

@@ -0,0 +1,15 @@
+module MailerLite
+  # Faraday response middleware
+  module Middleware
+    # This class raises an exception based HTTP status codes returned
+    # by the API.
+    class RaiseError < Faraday::Response::Middleware
+      private
+
+      def on_complete(response)
+        error = MailerLite::Error.from_response(response)
+        raise error if error
+      end
+    end
+  end
+end

data/lib/mailerlite/middleware/underscore_keys.rb

@@ -0,0 +1,26 @@
+module MailerLite
+  module Middleware
+    # This class will underscore all response keys from CamelCase.
+    class UnderscoreKeys < Faraday::Response::Middleware
+      private
+
+      def on_complete(response)
+        response[:body] = updated_response(response[:body])
+      end
+
+      def updated_response(response)
+        if response.is_a?(Hash)
+          underscore_hash_keys(response)
+        else
+          response
+        end
+      end
+
+      def underscore_hash_keys(hash)
+        hash.each_with_object({}) do |(k, v), new_hash|
+          new_hash[k.underscore] = updated_response(v)
+        end
+      end
+    end
+  end
+end

data/lib/mailerlite/version.rb

@@ -0,0 +1,3 @@
+module MailerLite
+  VERSION = '0.1.0'.freeze
+end

data/lib/mailerlite.rb

@@ -0,0 +1,22 @@
+require 'mailerlite/core_ext/string'
+
+require 'mailerlite/version'
+require 'mailerlite/error'
+require 'mailerlite/client'
+
+require 'faraday'
+
+module MailerLite
+  class << self
+    def client
+      @client ||= MailerLite::Client.new
+    end
+
+    private
+
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
+  end
+end

data/mailerlite.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mailerlite/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mailerlite'
+  spec.version       = MailerLite::VERSION
+  spec.authors       = ['Justas Palumickas']
+  spec.email         = ['jpalumickas@gmail.com']
+
+  spec.summary       = 'Ruby wrapper for MailerLite API'
+  spec.description   = 'Unofficial ruby gem for MailerLite API'
+  spec.homepage      = 'https://github.com/jpalumickas/mailerlite-ruby'
+
+  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']
+
+  spec.add_dependency 'faraday', '~> 0.9.2'
+  spec.add_dependency 'faraday_middleware', '~> 0.10.0'
+  spec.add_dependency 'hashie', '~> 3.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: mailerlite
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justas Palumickas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Unofficial ruby gem for MailerLite API
+email:
+- jpalumickas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mailerlite.rb
+- lib/mailerlite/client.rb
+- lib/mailerlite/clients/lists.rb
+- lib/mailerlite/configuration.rb
+- lib/mailerlite/connection.rb
+- lib/mailerlite/core_ext/string.rb
+- lib/mailerlite/error.rb
+- lib/mailerlite/middleware/raise_error.rb
+- lib/mailerlite/middleware/underscore_keys.rb
+- lib/mailerlite/version.rb
+- mailerlite.gemspec
+homepage: https://github.com/jpalumickas/mailerlite-ruby
+licenses: []
+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.6.3
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for MailerLite API
+test_files: []