mailerlite 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b653e7ee2b97df02b06cbbdb24b36acb55386856
-  data.tar.gz: 05adea07f99865e8d61cf1d8e2d42214c1ec7c56
+  metadata.gz: a739963fd127ae8c42af6a2ceacfded67e42eb96
+  data.tar.gz: 21d605553139028079007949fc7515877aa5c218
 SHA512:
-  metadata.gz: a88a88a51c5e22f50c287572f834a7bdc18cad89bce48e9d226185273ede75aad4ca8b8dd8a78548b722a5794ac4351ff74250e2383f4cfb0907998db9904294
-  data.tar.gz: 53e2597cc7f762d86b61754483e1f736bcaf4631a0677d76a7804dbc2fad27a1cb4e61f7579e0ad55e9bc69de85449bee73bcc0becd3e8b0fada9dc1ae16a011
+  metadata.gz: e3ee319eda69a4cb89625a105c09baa29a2291efb40ec1c55235c2336c177ece212ad376793722b56490eb3b792f10a596624d7861b8d35ecb28e414f4faa03d
+  data.tar.gz: 2d189d579c72281e66a45065f5b7ed3f785a36b9ab64d397e2dadf08d8b1d2e99c0bee41d4e0f3f2db742b680333524838ac1ec5191c8abeccb480febb75f8e7

data/.rubocop.yml

@@ -20,11 +20,15 @@ Style/MultilineMethodCallIndentation:
 
 Style/CaseIndentation:
   Enabled: true
-  IndentWhenRelativeTo: end
+  EnforcedStyle: end
 
 Lint/EndAlignment:
   Enabled: true
-  AlignWith: variable
+  EnforcedStyleAlignWith: variable
 
 Style/FrozenStringLiteralComment:
   Enabled: false
+
+Metrics/BlockLength:
+  ExcludedMethods:
+    - 'describe'

data/Gemfile

@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 
 group :development do
   gem 'guard-rspec', '~> 4.7'
-  gem 'rubocop', '~> 0.46'
+  gem 'rubocop', '~> 0.48'
 end
 
 group :development, :test do
@@ -14,7 +14,7 @@ group :test do
   gem 'coveralls', '~> 0.8', require: false
   gem 'rake' # For Travis CI
   gem 'rspec', '~> 3.5'
-  gem 'simplecov', '~> 0.12', require: false
+  gem 'simplecov', '~> 0.14', require: false
   gem 'webmock', '~> 2.3'
 end
 

data/README.md

@@ -18,6 +18,10 @@ gem 'mailerlite'
 
 ## Usage
 
+Before making any request, you should authenticate first. Use the response object to
+make requests afterward.
+See [create a campaign][create_a_campaign] example.
+
 ### Authentication
 
 When you sign up for an account, you are given an **API key**. You authenticate to
@@ -36,6 +40,8 @@ MailerLite.configure do |config|
 end
 ```
 
+See more documentation in [examples][examples] directory.
+
 ## Supported Ruby Versions
 
 This library aims to support and is [tested against][travis] the following Ruby
@@ -57,5 +63,7 @@ Copyright (c) 2017 Justas Palumickas. See [LICENSE][license] for details.
 [codeclimate]: https://codeclimate.com/github/jpalumickas/mailerlite-ruby
 
 [license]: https://raw.githubusercontent.com/jpalumickas/mailerlite-ruby/master/LICENSE
+[create_a_campaign]: https://raw.githubusercontent.com/jpalumickas/mailerlite-ruby/master/examples/create_campaign.md
+[examples]: https://github.com/jpalumickas/mailerlite-ruby/tree/master/examples
 
 [mailerlite]: https://www.mailerlite.com

data/examples/README.md

@@ -0,0 +1,13 @@
+# MailerLite Examples
+
+## Documentation
+
+* [Authentication](authentication.md)
+* [Campaigns](campaigns.md)
+* [Fields](fields.md)
+* [Groups](groups.md)
+* [Subscribers](subscribers.md)
+
+## How To
+
+* [How to create a campaign](create_campaign.md)

data/examples/campaigns.md

@@ -0,0 +1,31 @@
+# Campaigns
+
+## Create campaign where you will use your custom HTML template
+
+```ruby
+client.create_campaign
+```
+
+## Upload your HTML template to created campaign
+
+```ruby
+client.update_campaign_content(id, options)
+```
+
+## Send, schedule or cancel campaign
+
+```ruby
+client.campaign_action(id, action)
+```
+
+## Returns all campaigns you have in your account by :status which is required. Also basic summary for each campaign including the ID
+
+```ruby
+client.campaign_by_status(status)
+```
+
+## Remove a campaign
+
+```ruby
+client.delete_campaign(id)
+```

data/examples/create_campaign.md

@@ -0,0 +1,44 @@
+#Create Campaign Example
+
+##1. Authentication
+See [Developer API](https://app.mailerlite.com/integrations/api/) and find **API Key** there.
+```ruby
+client = MailerLite::Client.new(api_key: 'my-secret-api-key')
+```
+
+##2. Create a group
+create a group indicating the receivers.
+```ruby
+group = client.create_group('example_group')
+```
+##3. Add user to the created group
+```ruby
+client.create_group_subscriber(group.id, { email: 'an@example.com',
+fields: {name: 'An Example'}})
+```
+##4. Create a campaign with created group
+```ruby
+campaign = client.create_campaign(
+    type: 'regular',
+    subject: 'Newsletter',
+    from: 'john_smith@example.com',
+    from_name: 'John Smith',
+    groups: [ group.id ],
+    language: 'en'
+)
+```
+##5. Put content in the campaign
+```ruby
+html = "<div>Welcome,<br /><a href=\"{$unsubscribe}\">Unsubscribe</a></div>"
+plain_text = 'Welcome, {$unsubscribe} {$url}'
+client.update_campaign_content(campaign.id, html: html, plain: plain_text )
+```
+`${url}` must be exist in plain text.
+`${unsubscribe}` must be exist in both plain text and html. See the [API documentation](http://developers.mailerlite.com/reference#put-custom-content-to-campaign).
+
+##6. Send the campaign
+```ruby
+client.campaign_action(campaign.id, 'send')
+```
+hint: According to current API, you may not resend a campaign.
+note: Currently, setting campaigns language parameter to "fa" for "Farsi" language causes an Internal Server Error on "send campaign" requests, use "pr" instead.

data/examples/fields.md

@@ -0,0 +1,25 @@
+# Fields
+
+## Get subscriber fields of account
+
+```ruby
+client.fields
+```
+
+## Create new custom field in account
+
+```ruby
+options = { title: 'Title', type: 'TEXT' }
+client.create_field(options)
+```
+
+## Update custom field in account
+
+```ruby
+client.update_field(id, { title: 'New title' })
+```
+
+##Remove custom field from account
+```ruby
+client.delete_field(id)
+```

data/examples/groups.md

@@ -0,0 +1,60 @@
+# Groups Examples
+
+## Get list of groups
+
+```ruby
+client.groups
+```
+
+## Get single group by ID
+
+```ruby
+client.group(group_id)
+```
+
+## Create new group
+
+```ruby
+client.create_group(name)
+```
+
+## Remove a group
+```ruby
+client.delete_group(group_id)
+```
+
+## Get all subscribers in a specified group
+
+```ruby
+client.group_subscribers(group_id)
+```
+
+## Add new single subscriber to specified group
+
+```ruby
+subscriber = { email: 'subsriber@example.com' }
+client.create_group_subscriber(1, subscriber)
+```
+
+## Add many new subscribers to specified group at once
+
+```ruby
+subscribers = [
+  { email: 'subscriber1@example.com' },
+  { email: 'subscriber2@example.com' }
+]
+
+client.import_group_subscribers(1, subscribers, resubscribe: true)
+```
+
+## Remove single subscriber from specified group
+
+```ruby
+client.delete_group_subscriber(group_id, 'demo@mailerlite.com')
+```
+
+or
+
+```ruby
+client.delete_group_subscriber(group_id, subscriber_id)
+```

data/examples/subscribers.md

@@ -0,0 +1,66 @@
+# Subscribers
+
+## Get single subscriber
+
+```ruby
+client.subscriber(subscriber_id)
+```
+
+or with email
+
+```ruby
+client.subscriber('user@example.com')
+```
+
+## Update single subscriber
+
+```ruby
+client.update_subscriber(subscriber_id options)
+```
+
+or with email
+
+```ruby
+client.update_subscriber('user@example.com', options)
+```
+
+`options` can be:
+
+- `fields` [Array]: Associated array where key is the same as field key.
+- `type` [String]: Available values: `unsubscribed`, `active`
+- `resend_autoresponders` [Boolean]: Defines if it is needed to resend autoresponders
+
+## Search for subscribers
+
+```ruby
+options = {
+  query: 'example',
+  limit: 1,
+  minimized: true
+}
+
+client.search_subscribers(query, options)
+```
+
+## Get groups subscriber belongs to
+
+```ruby
+client.subscriber_groups(subscriber_id)
+```
+
+or with email
+
+```ruby
+client.subscriber_groups('user@example.com')
+```
+
+## Get activites (clicks, opens, etc.) of selected subscriber
+```ruby
+client.subscriber_activities(subscriber_id)
+```
+
+or with email
+
+```ruby
+client.subscriber_activities('user@example.com')
+```

data/lib/mailerlite/clients/campaigns.rb

@@ -49,6 +49,28 @@ module MailerLite
       def campaign_action(id, action)
         connection.post("campaigns/#{id}/actions/#{action}")
       end
+
+      # Returns all campaigns you have in your account by :status which is
+      # required. Also basic summary for each campaign including the ID.
+      #
+      # @see http://developers.mailerlite.com/reference#campaigns-by-type
+      #
+      # @param status [String] possible values: 'sent', 'outbox', 'draft'
+      # no value means 'sent'
+      #
+      # @return Response from API.
+      def campaigns_by_status(status)
+        connection.get("campaigns/#{status}")
+      end
+
+      # Remove a campaign.
+      #
+      # @param id [Integer] id of campaign
+      #
+      # @return [Boolean] Response from API.
+      def delete_campaign(id)
+        connection.delete("campaigns/#{id}")
+      end
     end
   end
 end

data/lib/mailerlite/clients/groups.rb

@@ -11,11 +11,25 @@ module MailerLite
         connection.get('groups')
       end
 
+      # Get single group by ID
+      #
+      # @see http://developers.mailerlite.com/reference#single-group
+      #
+      # @param id [Integer] Id of group
+      #
+      # @return [Hash] Response from API.
       def group(id)
         result = connection.get("groups/#{id}")
         result.is_a?(Array) ? result[0] : result
       end
 
+      # Create new group
+      #
+      # @see http://developers.mailerlite.com/reference#create-group
+      #
+      # @param name [String] Name of your group
+      #
+      # @return [Hash] Response from API.
       def create_group(name)
         connection.post('groups', name: name)
       end
@@ -24,26 +38,67 @@ module MailerLite
         connection.put("groups/#{id}", options)
       end
 
+      # Remove group
+      #
+      # @see http://developers.mailerlite.com/reference#delete-group
+      #
+      # @param [Integer] Id of group
+      #
+      # @return [Boolean] Response from API.
       def delete_group(id)
         connection.delete("groups/#{id}")
       end
 
+      # Get all subscribers in a specified group
+      #
+      # @see http://developers.mailerlite.com/reference#subscribers-in-a-group
+      #
+      # @param group_id [Integer] Id of group
+      # @param options [Hash] Request options
+      #
+      # @return [Array] Subscribers
       def group_subscribers(group_id, options = {})
         connection.get("groups/#{group_id}/subscribers", options)
       end
 
+      # Add new single subscriber to specified group
+      #
+      # @see http://developers.mailerlite.com/reference#add-single-subscriber
+      #
+      # @param group_id [Integer] Id of group
+      # @param options [Hash] Request options
+      #
+      # @return [Hash] Response from API
       def create_group_subscriber(group_id, options = {})
         connection.post("groups/#{group_id}/subscribers", options)
       end
 
+      # Add many new subscribers to specified group at once
+      #
+      # @see http://developers.mailerlite.com/reference#add-many-subscribers
+      #
+      # @param group_id [Integer] Id of group
+      # @param subscribers [Array] Array of hash each indicates a subscriber
+      # @param options [Hash] Request options
+      #
+      # @return [Hash] Response from API.
       def import_group_subscribers(group_id, subscribers, options = {})
         options[:subscribers] = subscribers
         connection.post("groups/#{group_id}/subscribers/import", options)
       end
 
+      # Remove single subscriber from specified group
+      #
+      # @see http://developers.mailerlite.com/reference#remove-subscriber
+      #
+      # @param group_id [Integer|String] Id of group
+      # @param subscriber_id_or_email [Array] Id or email of subscriber
+      #
+      # @return [Hash] Response from API.
       def delete_group_subscriber(group_id, subscriber_id_or_email)
+        escaped_subscriber_id_or_email = CGI.escape(subscriber_id_or_email)
         connection.delete(
-          "groups/#{group_id}/subscribers/#{subscriber_id_or_email}"
+          "groups/#{group_id}/subscribers/#{escaped_subscriber_id_or_email}"
         )
       end
     end

data/lib/mailerlite/connection.rb

@@ -2,6 +2,7 @@ require 'faraday'
 require 'faraday_middleware'
 require 'json'
 
+require 'mailerlite/mash'
 require 'mailerlite/middleware/raise_error'
 require 'mailerlite/middleware/underscore_keys'
 require 'mailerlite/middleware/fix_unparsed_json'
@@ -63,7 +64,7 @@ module MailerLite
         builder.request :json
 
         builder.use FaradayMiddleware::FollowRedirects
-        builder.use FaradayMiddleware::Mashify
+        builder.use FaradayMiddleware::Mashify, mash_class: MailerLite::Mash
         builder.use MailerLite::Middleware::UnderscoreKeys
         builder.use FaradayMiddleware::ParseJson
         builder.use MailerLite::Middleware::FixUnparsedJson

data/lib/mailerlite/mash.rb

@@ -0,0 +1,7 @@
+require 'hashie/mash'
+
+module MailerLite
+  class Mash < Hashie::Mash
+    disable_warnings
+  end
+end

data/lib/mailerlite/version.rb

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

data/mailerlite.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'mailerlite/version'
@@ -25,7 +26,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'faraday', '~> 0.10'
   spec.add_dependency 'faraday_middleware', '~> 0.10'
-  spec.add_dependency 'hashie', '~> 3.4'
+  spec.add_dependency 'hashie', '~> 3.5.5'
 
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailerlite
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Justas Palumickas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-04 00:00:00.000000000 Z
+date: 2017-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 3.5.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 3.5.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -99,7 +99,13 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/README.md
 - examples/authentication.md
+- examples/campaigns.md
+- examples/create_campaign.md
+- examples/fields.md
+- examples/groups.md
+- examples/subscribers.md
 - lib/mailerlite.rb
 - lib/mailerlite/client.rb
 - lib/mailerlite/clients/campaigns.rb
@@ -110,6 +116,7 @@ files:
 - lib/mailerlite/connection.rb
 - lib/mailerlite/core_ext/string.rb
 - lib/mailerlite/error.rb
+- lib/mailerlite/mash.rb
 - lib/mailerlite/middleware/fix_unparsed_json.rb
 - lib/mailerlite/middleware/raise_error.rb
 - lib/mailerlite/middleware/underscore_keys.rb
@@ -135,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for MailerLite API v2