mailerlite 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 429068032003d8d580e7558e2cdb4ebe03837156
-  data.tar.gz: 6a079e90259500321c692d80c6ae269fbcc9c29f
+  metadata.gz: 8778460cc49d8f082a725d64b698686907432a79
+  data.tar.gz: 7172a78894facf2a778c839158c3f0521419ec2a
 SHA512:
-  metadata.gz: f48c09315918f8061f0d8669f0873de0491f0cacaff59fa1615fabc299ace35b1729680ad853ee8922e31069361d758698b479d9dcbb34d41a19686dcf6782a0
-  data.tar.gz: 58b50f488ae6107d6808d8c237f3ff73405b3a0cf626c93ab6ae13bacdb3757462492e1f297be09afaf8066592c18cade543a2baac4d187e4b4a9d363a8a873e
+  metadata.gz: dff75234d4a7540eeb19c19e8646f1a106c10a3818ff4471fa030417c196672e388f0d270749616649b1a9075ee2dbaa7bfd1d39177584b56f150048a8e7dd4d
+  data.tar.gz: c4cb1b149695aadbde493de0dd305edc51e796ba54e5b54f6e6306b92295049c92ee28285eed72b22d9db97e23675dec08042dfd3228acc178ed59c5dc83ccda

data/README.md

@@ -47,10 +47,15 @@ implementations:
 * Ruby 2.2.0
 * Ruby 2.3.0
 
+## Copyright
+Copyright (c) 2016 Justas Palumickas. See [LICENSE][license] for details.
+
 [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
 
+[license]: https://raw.githubusercontent.com/jpalumickas/mailerlite-ruby/master/LICENSE
+
 [mailerlite]: https://www.mailerlite.com

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "mailerlite"
+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.
@@ -10,5 +10,5 @@ require "mailerlite"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/examples/authentication.md

@@ -0,0 +1,38 @@
+# Authentication Example
+
+When you sign up for an account, you are given an **API key**. You authenticate to
+the [MailerLite][mailerlite] API by providing your API key in the request.
+You can find your API key in page: Integrations » Developer API.
+
+## Using variable
+
+```ruby
+client = MailerLite::Client.new(api_key: 'my-secret-api-key')
+```
+
+Example:
+
+```ruby
+client.campaigns
+```
+
+## Using global class config
+
+Or create file under `config/initializers/mailerlite.rb`
+
+```ruby
+MailerLite.configure do |config|
+  config.api_key = 'my-secret-api-key'
+end
+```
+
+When you configured in file, you can request methods on `MailerLite` class
+directly.
+
+Example:
+
+```ruby
+MailerLite.campaigns
+```
+
+[mailerlite]: https://www.mailerlite.com

data/examples/campaigns.md

@@ -0,0 +1,62 @@
+# 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.rb

@@ -4,6 +4,7 @@ require 'mailerlite/version'
 require 'mailerlite/error'
 require 'mailerlite/client'
 
+# Main module for gem.
 module MailerLite
   class << self
     def client

data/lib/mailerlite/client.rb

@@ -3,11 +3,14 @@ require 'mailerlite/configuration'
 
 require 'mailerlite/clients/campaigns'
 require 'mailerlite/clients/lists'
+require 'mailerlite/clients/subscribers'
 
 module MailerLite
+  # Wrapper class for all actions.
   class Client
     include MailerLite::Clients::Campaigns
     include MailerLite::Clients::Lists
+    include MailerLite::Clients::Subscribers
 
     def initialize(options = {})
       config.api_key = options[:api_key] if options[:api_key]
@@ -16,6 +19,7 @@ module MailerLite
     def config
       @config ||= Configuration.new
     end
+    alias configuration config
 
     def configure
       yield(config) if block_given?

data/lib/mailerlite/clients/subscribers.rb

@@ -0,0 +1,33 @@
+module MailerLite
+  module Clients
+    # Get information about MailerLite Subscribers.
+    #
+    # You can official documentation at
+    # https://docs.mailerlite.com/pages/subscribers
+    module Subscribers
+      def create_subscriber(list_id, email, options = {})
+        options[:email] = email
+
+        connection.post("subscribers/#{list_id}/", options)
+      end
+
+      def create_subscribers(list_id, options = {})
+        connection.post("subscribers/#{list_id}/import/", options)
+      end
+
+      def subscriber(email, options = {})
+        options[:email] = email
+
+        connection.get('subscribers/', options)
+      end
+
+      def delete_subscriber(list_id, email)
+        connection.delete("subscribers/#{list_id}/", email: email)
+      end
+
+      def unsubscribe_subscriber(email)
+        connection.post('subscribers/unsubscribe/', email: email)
+      end
+    end
+  end
+end

data/lib/mailerlite/configuration.rb

@@ -1,6 +1,5 @@
-require 'faraday_middleware'
-
 module MailerLite
+  # A class responsible for all configurations.
   class Configuration
     # Default API endpoint
     API_ENDPOINT = 'https://app.mailerlite.com/api/v1'.freeze

data/lib/mailerlite/connection.rb

@@ -1,10 +1,12 @@
 require 'faraday'
+require 'faraday_middleware'
 require 'json'
 
 require 'mailerlite/middleware/raise_error'
 require 'mailerlite/middleware/underscore_keys'
 
 module MailerLite
+  # A class responsible for connecting to MailerLite API and making requests.
   class Connection
     attr_reader :client
 

data/lib/mailerlite/core_ext/string.rb

@@ -1,9 +1,10 @@
+# Custom String extensions
 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
+    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

@@ -1,4 +1,5 @@
 module MailerLite
+  # Base MailerLite error.
   class Error < StandardError
     # Returns the appropriate MailerLite::Error sublcass based
     # on status and response message.

data/lib/mailerlite/version.rb

@@ -1,3 +1,3 @@
 module MailerLite
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailerlite
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Justas Palumickas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-17 00:00:00.000000000 Z
+date: 2016-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -111,10 +111,13 @@ files:
 - Rakefile
 - 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/subscribers.rb
 - lib/mailerlite/configuration.rb
 - lib/mailerlite/connection.rb
 - lib/mailerlite/core_ext/string.rb