mailerlite 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efd9c3192e8b0b5803b0e38ad265b850315cc347
-  data.tar.gz: dbd161446be6234bd65db1eda6c06cea96d8dcfc
+  metadata.gz: 429068032003d8d580e7558e2cdb4ebe03837156
+  data.tar.gz: 6a079e90259500321c692d80c6ae269fbcc9c29f
 SHA512:
-  metadata.gz: 5bdacde3271be3b651fdb21a664585f3b4fc2d33cb2bc59899fcdb7b777784768956710c9d42ed53d2019645ebd264740694e12b14ee914e7ecefc8d6dd82bff
-  data.tar.gz: e26de30288431b82a8c099ac20428db695947420b878ea1a72c799be73cf68f8ed4646b4d7ec46c314e7ba6d921eb04a80c5c565ccc4a73573a6f0de9c6fe596
+  metadata.gz: f48c09315918f8061f0d8669f0873de0491f0cacaff59fa1615fabc299ace35b1729680ad853ee8922e31069361d758698b479d9dcbb34d41a19686dcf6782a0
+  data.tar.gz: 58b50f488ae6107d6808d8c237f3ff73405b3a0cf626c93ab6ae13bacdb3757462492e1f297be09afaf8066592c18cade543a2baac4d187e4b4a9d363a8a873e

data/CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# How to contribute
+
+I like to encourage you to contribute to the repository.
+This should be as easy as possible for you but there are a few things to consider when contributing.
+The following guidelines for contribution should be followed if you want to submit a pull request.
+
+## How to prepare
+
+* You need a [GitHub account](https://github.com/signup/free)
+* Submit an [issue ticket](https://github.com/jpalumickas/mailerlite-ruby/issues) for your issue if the is no one yet.
+  * Describe the issue and include steps to reproduce if it's a bug.
+  * Ensure to mention the earliest version that you know is affected.
+* If you are able and want to fix this, fork the repository on GitHub
+
+## Make Changes
+
+* In your forked repository, create a topic branch for your upcoming patch. (e.g. `feature--autoplay` or `bugfix--ios-crash`)
+  * Usually this is based on the master branch.
+  * Create a branch based on master; `git branch
+  fix/master/my_contribution master` then checkout the new branch with `git
+  checkout fix/master/my_contribution`.  Please avoid working directly on the `master` branch.
+* Make sure you stick to the coding style that is used already.
+* Make use of the `.editorconfig`-file if provided with the repository.
+* Make commits of logical units and describe them properly.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+
+* If possible, submit tests to your patch / new feature so it can be tested easily.
+* Assure nothing is broken by running all the tests.
+
+## Submit Changes
+
+* Push your changes to a topic branch in your fork of the repository.
+* Open a pull request to the original repository and choose the right original branch you want to patch.
+  _Advanced users may use [`hub`](https://github.com/defunkt/hub#git-pull-request) gem for that._
+* If not done in commit messages (which you really should do) please reference and update your issue with the code changes. But _please do not close the issue yourself_.
+_Notice: You can [turn your previously filed issues into a pull-request here](http://issue2pr.herokuapp.com/)._
+* Even if you have write access to the repository, do not directly push or merge pull-requests. Let another team member review your pull request and approve.
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

data/Gemfile

@@ -8,6 +8,7 @@ group :test do
   gem 'codeclimate-test-reporter', require: false
   gem 'coveralls',    '~> 0.8.13', require: false
   gem 'guard-rspec',  '~> 4.6.5'
+  gem 'rake' # For Travis CI
   gem 'simplecov',    '~> 0.11.2', require: false
   gem 'webmock',      '~> 1.24.3'
 end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Justas Palumickas
+
+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

@@ -20,6 +20,10 @@ gem 'mailerlite'
 
 ### Authentication
 
+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.
+
 ```ruby
 client = MailerLite::Client.new(api_key: 'my-secret-api-key')
 ```

data/lib/mailerlite/client.rb

@@ -1,10 +1,12 @@
 require 'mailerlite/connection'
 require 'mailerlite/configuration'
 
+require 'mailerlite/clients/campaigns'
 require 'mailerlite/clients/lists'
 
 module MailerLite
   class Client
+    include MailerLite::Clients::Campaigns
     include MailerLite::Clients::Lists
 
     def initialize(options = {})

data/lib/mailerlite/clients/campaigns.rb

@@ -0,0 +1,42 @@
+module MailerLite
+  module Clients
+    # Get information about MailerLite Campaigns.
+    #
+    # You can official documentation at
+    # https://docs.mailerlite.com/pages/campaigns
+    module Campaigns
+      def campaigns(options = {})
+        connection.get('campaigns/', options)
+      end
+
+      def campaign(id)
+        connection.get("campaigns/#{id}/")
+      end
+
+      def campaign_recipients(id, options = {})
+        connection.get("campaigns/#{id}/recipients/", options)
+      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/lists.rb

@@ -1,5 +1,9 @@
 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)

data/lib/mailerlite/version.rb

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

data/lib/mailerlite.rb

@@ -4,8 +4,6 @@ require 'mailerlite/version'
 require 'mailerlite/error'
 require 'mailerlite/client'
 
-require 'faraday'
-
 module MailerLite
   class << self
     def client

data/mailerlite.gemspec

@@ -10,9 +10,11 @@ Gem::Specification.new do |spec|
   spec.email         = ['jpalumickas@gmail.com']
 
   spec.summary       = 'Ruby wrapper for MailerLite API'
-  spec.description   = 'Unofficial ruby gem for MailerLite API'
+  spec.description   = 'Ruby gem for MailerLite API'
   spec.homepage      = 'https://github.com/jpalumickas/mailerlite-ruby'
 
+  spec.license       = 'MIT'
+
   spec.files         = `git ls-files -z`
                        .split("\x0")
                        .reject { |f| f.match(%r{^(test|spec|features)/}) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailerlite
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Justas Palumickas
@@ -94,7 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-description: Unofficial ruby gem for MailerLite API
+description: Ruby gem for MailerLite API
 email:
 - jpalumickas@gmail.com
 executables: []
@@ -104,13 +104,16 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CONTRIBUTING.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/mailerlite.rb
 - lib/mailerlite/client.rb
+- lib/mailerlite/clients/campaigns.rb
 - lib/mailerlite/clients/lists.rb
 - lib/mailerlite/configuration.rb
 - lib/mailerlite/connection.rb
@@ -121,7 +124,8 @@ files:
 - lib/mailerlite/version.rb
 - mailerlite.gemspec
 homepage: https://github.com/jpalumickas/mailerlite-ruby
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []