mailerlite 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8778460cc49d8f082a725d64b698686907432a79
-  data.tar.gz: 7172a78894facf2a778c839158c3f0521419ec2a
+  metadata.gz: 843af19f90d52a10946d15d6e01a18145ea9d42f
+  data.tar.gz: dab4fc1e6262cd7534ce338603c5f8229a845d1c
 SHA512:
-  metadata.gz: dff75234d4a7540eeb19c19e8646f1a106c10a3818ff4471fa030417c196672e388f0d270749616649b1a9075ee2dbaa7bfd1d39177584b56f150048a8e7dd4d
-  data.tar.gz: c4cb1b149695aadbde493de0dd305edc51e796ba54e5b54f6e6306b92295049c92ee28285eed72b22d9db97e23675dec08042dfd3228acc178ed59c5dc83ccda
+  metadata.gz: afa2abd88a4f60d9b6ef7062fc1f6e403ebea6d5e07bfdd52d95620d5871a5e80b256a281e2fc85ff87c33fb285f5bdb6ccd82f89a8eb44daedf365363c83ba9
+  data.tar.gz: 4c8e17942c01e12c5806f05b758cd67e6f461bc1f9641a5dcc2cb8b34c5be7944fd8d49490c81466b8de9333ace95633c574fc4d1babaa47716911859052a276

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,30 @@
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - '**/Gemfile'
+
+Style/Documentation:
+  Enabled: false
+
+Style/AlignParameters:
+  Enabled: true
+  EnforcedStyle: with_fixed_indentation
+
+Style/MultilineOperationIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Style/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Style/CaseIndentation:
+  Enabled: true
+  IndentWhenRelativeTo: end
+
+Lint/EndAlignment:
+  Enabled: true
+  AlignWith: variable
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -8,18 +8,12 @@ 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

@@ -1,16 +1,21 @@
 source 'https://rubygems.org'
 
+group :development do
+  gem 'guard-rspec', '~> 4.7.3'
+  gem 'rubocop', '~> 0.42'
+end
+
 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 'coveralls', '~> 0.8.15', require: false
   gem 'rake' # For Travis CI
-  gem 'simplecov',    '~> 0.11.2', require: false
-  gem 'webmock',      '~> 1.24.3'
+  gem 'rspec', '~> 3.5'
+  gem 'simplecov', '~> 0.12', require: false
+  gem 'webmock', '~> 2.1'
 end
 
 gemspec

data/README.md

@@ -41,7 +41,6 @@ end
 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

data/lib/mailerlite.rb

@@ -17,5 +17,9 @@ module MailerLite
       return super unless client.respond_to?(method_name)
       client.send(method_name, *args, &block)
     end
+
+    def respond_to_missing?(method_name, include_private = false)
+      client.respond_to?(method_name, include_private)
+    end
   end
 end

data/lib/mailerlite/client.rb

@@ -2,30 +2,39 @@ require 'mailerlite/connection'
 require 'mailerlite/configuration'
 
 require 'mailerlite/clients/campaigns'
-require 'mailerlite/clients/lists'
+require 'mailerlite/clients/fields'
+require 'mailerlite/clients/groups'
 require 'mailerlite/clients/subscribers'
 
 module MailerLite
   # Wrapper class for all actions.
   class Client
     include MailerLite::Clients::Campaigns
-    include MailerLite::Clients::Lists
+    include MailerLite::Clients::Fields
+    include MailerLite::Clients::Groups
     include MailerLite::Clients::Subscribers
 
+    # Initialize client.
+    #
+    # @param options [Hash] A customizable set of options.
+    # @option options [String] :api_key API Key provider from MailerLite.
     def initialize(options = {})
       config.api_key = options[:api_key] if options[:api_key]
     end
 
+    # @return [Configuration]
     def config
       @config ||= Configuration.new
     end
     alias configuration config
 
+    # Configure client with a block of settings.
     def configure
       yield(config) if block_given?
       true
     end
 
+    # @return [Connection]
     def connection
       @connection ||= Connection.new(self)
     end

data/lib/mailerlite/clients/campaigns.rb

@@ -1,42 +1,54 @@
 module MailerLite
   module Clients
-    # Get information about MailerLite Campaigns.
-    #
-    # You can official documentation at
-    # https://docs.mailerlite.com/pages/campaigns
+    # MailerLite Campaigns.
     module Campaigns
-      def campaigns(options = {})
-        connection.get('campaigns/', options)
+      # Create campaign where you will use your custom HTML template
+      #
+      # @see https://developers.mailerlite.com/docs/campaigns
+      #
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :type Type of campaign. Available values:
+      #   regular, ab.
+      # @option options [String] :subject Mail subject. Required if campaign
+      #   type is regular.
+      # @option options [String] :from Email of sender
+      # @option options [String] :from_name Name of sender
+      # @option options [String] :language ISO 639-1
+      # @option options [Array] :groups IDs of groups
+      # @option options [Hash] :ab_settings Required if campaign type is ab.
+      #
+      # @return [Hash] Response from API.
+      def create_campaign(options = {})
+        connection.post('campaigns', options)
       end
 
-      def campaign(id)
-        connection.get("campaigns/#{id}/")
+      # Upload your HTML template to created campaign
+      #
+      # @see https://developers.mailerlite.com/docs/put-custom-content-to-campaign
+      #
+      # @param id [Integer] ID of campaign
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :html HTML template source
+      # @option options [String] :plain Plain text of email
+      # @option options [Boolean] :auto_inline Defines if it is needed to
+      #   convert available CSS to inline CSS (excluding media queries)
+      #
+      # @return [Hash] Response from API.
+      def update_campaign_content(id, options = {})
+        connection.put("campaigns/#{id}/content", options)
       end
 
-      def campaign_recipients(id, options = {})
-        connection.get("campaigns/#{id}/recipients/", options)
+      # Send, schedule or cancel campaign
+      #
+      # @see https://developers.mailerlite.com/docs/campaign-actions-and-triggers
+      #
+      # @param id [Integer] ID of campaign
+      # @param action [String] Action type. Possible values: send, cancel
+      #
+      # @return [Hash] Response from API.
+      def campaign_action(id, action)
+        connection.post("campaigns/#{id}/actions/#{action}")
       end
-
-      def campaign_opens(id, options = {})
-        connection.get("campaigns/#{id}/opens/", options)
-      end
-
-      def campaign_clicks(id, options = {})
-        connection.get("campaigns/#{id}/clicks/", options)
-      end
-
-      def campaign_unsubscribes(id, options = {})
-        connection.get("campaigns/#{id}/unsubscribes/", options)
-      end
-
-      def campaign_bounces(id, options = {})
-        connection.get("campaigns/#{id}/bounces/", options)
-      end
-
-      def campaign_junk(id, options = {})
-        connection.get("campaigns/#{id}/junk/", options)
-      end
-      alias campaign_spam_complaints campaign_junk
     end
   end
 end

data/lib/mailerlite/clients/fields.rb

@@ -0,0 +1,53 @@
+module MailerLite
+  module Clients
+    # Get information about MailerLite Fields
+    module Fields
+      # Get subscriber fields of account
+      #
+      # @see https://developers.mailerlite.com/docs/all-fields
+      #
+      # @return [Array] Response from API.
+      def fields
+        connection.get('fields')
+      end
+
+      # Create new custom field in account
+      #
+      # @see https://developers.mailerlite.com/docs/create-field
+      #
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :title Title of field
+      # @option options [String] :type Type of field. Available values:
+      #   TEXT, INTEGER, DATE
+      #
+      # @return [Hash] Response from API.
+      def create_field(options = {})
+        connection.post('fields', options)
+      end
+
+      # Update custom field in account
+      #
+      # @see https://developers.mailerlite.com/docs/update-field
+      #
+      # @param id [Integer] ID of field.
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :title Title of field
+      #
+      # @return [Hash] Response from API.
+      def update_field(id, options = {})
+        connection.put("fields/#{id}", options)
+      end
+
+      # Remove custom field from account
+      #
+      # @see https://developers.mailerlite.com/docs/remove-field
+      #
+      # @param id [Integer] ID of field.
+      #
+      # @return [Hash] Response from API.
+      def delete_field(id)
+        connection.delete("fields/#{id}")
+      end
+    end
+  end
+end

data/lib/mailerlite/clients/groups.rb

@@ -0,0 +1,49 @@
+module MailerLite
+  module Clients
+    # Get information about MailerLite Lists.
+    #
+    # You can official documentation at
+    # https://developers.mailerlite.com/docs/groups
+    module Groups
+      def groups
+        connection.get('groups')
+      end
+
+      def group(id)
+        result = connection.get("groups/#{id}")
+        result.is_a?(Array) ? result[0] : result
+      end
+
+      def create_group(name)
+        connection.post('groups', name: name)
+      end
+
+      def update_group(id, options = {})
+        connection.put("groups/#{id}", options)
+      end
+
+      def delete_group(id)
+        connection.delete("groups/#{id}")
+      end
+
+      def group_subscribers(group_id, options = {})
+        connection.get("groups/#{group_id}/subscribers", options)
+      end
+
+      def create_group_subscriber(group_id, options = {})
+        connection.post("groups/#{group_id}/subscribers", options)
+      end
+
+      def import_group_subscribers(group_id, subscribers, options = {})
+        options[:subscribers] = subscribers
+        connection.post("groups/#{group_id}/subscribers/import", options)
+      end
+
+      def delete_group_subscriber(group_id, subscriber_id_or_email)
+        connection.delete(
+          "groups/#{group_id}/subscribers/#{subscriber_id_or_email}"
+        )
+      end
+    end
+  end
+end

data/lib/mailerlite/clients/subscribers.rb

@@ -2,32 +2,74 @@ module MailerLite
   module Clients
     # Get information about MailerLite Subscribers.
     #
-    # You can official documentation at
-    # https://docs.mailerlite.com/pages/subscribers
+    # @see https://docs.mailerlite.com/pages/subscribers
     module Subscribers
-      def create_subscriber(list_id, email, options = {})
-        options[:email] = email
-
-        connection.post("subscribers/#{list_id}/", options)
+      # Get single subscriber
+      #
+      # @see https://developers.mailerlite.com/docs/single-subscriber
+      #
+      # @param identifier [Integer,String] ID or email of subscriber.
+      #
+      # @return [Hash] Response from API.
+      def subscriber(identifier)
+        connection.get("subscribers/#{identifier}")
       end
 
-      def create_subscribers(list_id, options = {})
-        connection.post("subscribers/#{list_id}/import/", options)
+      # Update single subscriber
+      #
+      # @see https://developers.mailerlite.com/docs/update-subscriber
+      #
+      # @param identifier [Integer,String] ID or email of subscriber.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Array] :fields Associated array where key is the same
+      #   as field key.
+      # @option options [String] :type Available values: unsubscribed, active
+      # @option options [Boolean] :resend_autoresponders Defines if it is
+      #   needed to resend autoresponders
+      #
+      # @return [Hash] Response from API.
+      def update_subscriber(identifier, options = {})
+        connection.put("subscribers/#{identifier}", options)
       end
 
-      def subscriber(email, options = {})
-        options[:email] = email
-
-        connection.get('subscribers/', options)
+      # Search for subscribers
+      #
+      # @see https://developers.mailerlite.com/docs/search-for-subscribers
+      #
+      # @param query [String] Search query
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :offset
+      # @option options [Integer] :limit
+      # @option options [Boolean] :minimized
+      #
+      # @return [Array] Response from API.
+      def search_subscribers(query, options = {})
+        options[:query] = query
+        connection.get('subscribers/search', options)
       end
 
-      def delete_subscriber(list_id, email)
-        connection.delete("subscribers/#{list_id}/", email: email)
+      # Get groups subscriber belongs to
+      #
+      # @see https://developers.mailerlite.com/docs/groups-subscriber-belongs-to
+      #
+      # @param identifier [Integer,String] ID or email of subscriber.
+      #
+      # @return [Array] Response from API.
+      def subscriber_groups(identifier)
+        connection.get("subscribers/#{identifier}/groups")
       end
 
-      def unsubscribe_subscriber(email)
-        connection.post('subscribers/unsubscribe/', email: email)
+      # Get activity (clicks, opens, etc) of selected subscriber
+      #
+      # @see https://developers.mailerlite.com/docs/activity-of-single-subscriber
+      #
+      # @param identifier [Integer,String] ID or email of subscriber.
+      #
+      # @return [Array] Response from API.
+      def subscriber_activities(identifier)
+        connection.get("subscribers/#{identifier}/activity")
       end
+      alias subscriber_activity subscriber_activities
     end
   end
 end

data/lib/mailerlite/configuration.rb

@@ -1,20 +1,27 @@
 module MailerLite
   # A class responsible for all configurations.
   class Configuration
-    # Default API endpoint
-    API_ENDPOINT = 'https://app.mailerlite.com/api/v1'.freeze
+    # Default API endpoint.
+    API_ENDPOINT = 'https://api.mailerlite.com/api/v2'.freeze
 
-    # Default User Agent header string
+    # Default User Agent header string.
     USER_AGENT = "MailerLite Ruby v#{MailerLite::VERSION}".freeze
 
     attr_accessor :api_key
+    attr_writer :url, :user_agent
 
+    # Takes url provided from configuration or uses default one.
+    #
+    # @return [String] An API Endpoint url which will be used for connection.
     def url
-      API_ENDPOINT
+      @url || API_ENDPOINT
     end
 
+    # Takes user agent from configuration or uses default one.
+    #
+    # @return [String] User agent which will be used for connection headers.
     def user_agent
-      USER_AGENT
+      @user_agent || USER_AGENT
     end
   end
 end

data/lib/mailerlite/connection.rb

@@ -4,6 +4,7 @@ require 'json'
 
 require 'mailerlite/middleware/raise_error'
 require 'mailerlite/middleware/underscore_keys'
+require 'mailerlite/middleware/fix_unparsed_json'
 
 module MailerLite
   # A class responsible for connecting to MailerLite API and making requests.
@@ -18,29 +19,26 @@ module MailerLite
       request(:get, path, options).body
     end
 
-    def delete(path, options = {})
-      request(:delete, path, options).body
+    def put(path, options = {})
+      request(:put, 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
+      request(:post, path, {}, options).body
+    end
 
-      response.body
+    def delete(path, options = {})
+      request(:delete, path, options).body
     end
 
     private
 
-    def request(method, path, options = {})
-      options['apiKey'] = client.config.api_key
-
+    def request(method, path, query_params = {}, body_params = {})
       response = connection.send(method) do |request|
-        request.url(path, options)
+        request.url(path, query_params)
+        request.headers['Content-Type'] = 'application/json'
+        request.headers['X-MailerLite-ApiKey'] = client.config.api_key
+        request.body = body_params.to_json
       end
 
       response
@@ -64,6 +62,7 @@ module MailerLite
         builder.use FaradayMiddleware::Mashify
         builder.use MailerLite::Middleware::UnderscoreKeys
         builder.use FaradayMiddleware::ParseJson
+        builder.use MailerLite::Middleware::FixUnparsedJson
         builder.use MailerLite::Middleware::RaiseError
 
         builder.adapter Faraday.default_adapter

data/lib/mailerlite/error.rb

@@ -1,20 +1,21 @@
 module MailerLite
   # Base MailerLite error.
   class Error < StandardError
-    # Returns the appropriate MailerLite::Error sublcass based
-    # on status and response message.
+    # Returns the appropriate MailerLite::Error sublcass based on status and
+    # response message.
     #
-    # response - The Hash of HTTP response.
+    # @param response [Hash] HTTP response.
     #
-    # Returns the MailerLite::Error.
+    # @return [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
+      when 400 then MailerLite::BadRequest
+      when 401 then MailerLite::Unauthorized
+      when 404 then MailerLite::NotFound
+      when 500 then MailerLite::InternalServerError
+      end
 
       klass.new if klass
     end
@@ -22,6 +23,7 @@ module MailerLite
 
   # Raised when MailerLite returns a 400 HTTP status code
   class BadRequest < Error
+    # Default error message.
     def to_s
       'Missing a required parameter or calling invalid method'
     end
@@ -29,6 +31,7 @@ module MailerLite
 
   # Raised when MailerLite returns a 401 HTTP status code
   class Unauthorized < Error
+    # Default error message.
     def to_s
       'Invalid API key provided'
     end
@@ -36,8 +39,17 @@ module MailerLite
 
   # Raised when MailerLite returns a 404 HTTP status code
   class NotFound < Error
+    # Default error message.
     def to_s
       "Can't find requested items"
     end
   end
+
+  # Raised when MailerLite returns a 500 HTTP status code
+  class InternalServerError < Error
+    # Default error message.
+    def to_s
+      'The server encountered an unexpected condition'
+    end
+  end
 end

data/lib/mailerlite/middleware/fix_unparsed_json.rb

@@ -0,0 +1,12 @@
+module MailerLite
+  module Middleware
+    # This middleware will convert empty response to {}
+    class FixUnparsedJson < Faraday::Response::Middleware
+      private
+
+      def on_complete(response)
+        response[:body] = {} if response[:body] == ''
+      end
+    end
+  end
+end

data/lib/mailerlite/version.rb

@@ -1,3 +1,4 @@
 module MailerLite
-  VERSION = '0.3.0'.freeze
+  # @return [String] Version number.
+  VERSION = '1.0.0'.freeze
 end

data/mailerlite.gemspec

@@ -29,5 +29,4 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailerlite
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Justas Palumickas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-18 00:00:00.000000000 Z
+date: 2016-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !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: Ruby gem for MailerLite API
 email:
 - jpalumickas@gmail.com
@@ -102,7 +88,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CONTRIBUTING.md
 - Gemfile
@@ -112,16 +100,17 @@ files:
 - bin/console
 - bin/setup
 - examples/authentication.md
-- examples/campaigns.md
 - lib/mailerlite.rb
 - lib/mailerlite/client.rb
 - lib/mailerlite/clients/campaigns.rb
-- lib/mailerlite/clients/lists.rb
+- lib/mailerlite/clients/fields.rb
+- lib/mailerlite/clients/groups.rb
 - lib/mailerlite/clients/subscribers.rb
 - lib/mailerlite/configuration.rb
 - lib/mailerlite/connection.rb
 - lib/mailerlite/core_ext/string.rb
 - lib/mailerlite/error.rb
+- lib/mailerlite/middleware/fix_unparsed_json.rb
 - lib/mailerlite/middleware/raise_error.rb
 - lib/mailerlite/middleware/underscore_keys.rb
 - lib/mailerlite/version.rb
@@ -146,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for MailerLite API

data/examples/campaigns.md

@@ -1,62 +0,0 @@
-# Campaigns
-
-## Get all campaigns
-
-Returns all campaigns you have in your account.
-Also basic summary for each campaign including the ID.
-
-#### Example:
-
-```ruby
-client.campaigns
-```
-
-You can specify **limit** and **page** options:
-
-```ruby
-client.campaings(limit: 200, page: 2)
-```
-
-## Campaign details
-
-Retrieve stats about selected campaign with specified ID.
-
-#### Example:
-
-```ruby
-campaign_id = 123
-client.campaign(campaign_id)
-```
-
-## Campaign recipients
-
-Retrieves a paged result representing all the subscribers that a given campaign was sent to.
-
-#### Example:
-
-```ruby
-client.campaign_recipients(123)
-```
-
-You can specify **limit** and **page** options:
-
-```ruby
-client.campaing_recipients(123, limit: 200, page: 2)
-```
-
-
-## Campaign opens
-
-Retrieves a paged result representing all the subscribers that opened a given campaign.
-
-#### Example:
-
-```ruby
-client.campaign_opens(123)
-```
-
-You can specify **limit** and **page** options:
-
-```ruby
-client.campaing_opens(123, limit: 200, page: 2)
-```

data/lib/mailerlite/clients/lists.rb

@@ -1,41 +0,0 @@
-module MailerLite
-  module Clients
-    # Get information about MailerLite Lists.
-    #
-    # You can official documentation at
-    # https://docs.mailerlite.com/pages/lists
-    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