mailigen 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4702b01ebf3fb2519a1af3332e126c3d5fcb664c
-  data.tar.gz: 5d1fc92dfc32273b6e6d3c3392732abeaa8f9971
+  metadata.gz: 12e6e7d0978cd90bd64f01aef3319d4b30aa50d8
+  data.tar.gz: 97b985164bef8bd02b10750927b98e21d908561f
 SHA512:
-  metadata.gz: 39ddd7772e45f9c33878002897c20c862d6414edac0643921f73b2655e1bd80014669a5c7859159e6772269465ce8732b7787aaece2060f33dc2c5350467c85f
-  data.tar.gz: e6ec3ef331c98396f8bd0238515a91bd89cc94e4059f239e2240f16d69019c37f0bad86728d555ddb031f5bbea604e4ad810c26c84edbbd02021117233fdd22a
+  metadata.gz: ced7cf6662e323fe715469e41f28a210500ad628db5dbc5ff94fd5f00bdb440a8a603f9599eab1a9f1b7d205e1da2fe358b2a881816bc7dc014c55745e2c3724
+  data.tar.gz: 6889e48d23edae77f61af93605e8af3021031de846bea3ca2645f894739d7e2eccc14a8bd5192c9c5ded688e3128d514db4965d23b58e1f01ed2d6a44789ef8e

data/.gitignore

@@ -16,3 +16,4 @@ spec/keys
 test/tmp
 test/version_tmp
 tmp
+.coveralls.yml

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+# uncomment this line if your project needs to run something other than `rake`:
+script: bundle exec rspec spec

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+## 0.0.2
+
+### Features & Enhancements
+
+* Replace addressable gem with active_support/core_ext/object methods
+* Add some few tests for lists
+
+### Bug Fixes
+
+## 0.0.1
+
+* Initial release
+
+### Features & Enhancements
+
+* Basic API wrapper
+
+### Bug Fixes
+
+### Test Suite
+
+* RSpec
+
+### Contributors
+
+* Arturs Braucs
+* Creative Mobile

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in mailigen.gemspec
 gemspec
+
+gem 'coveralls', require: false

data/README.md

@@ -1,5 +1,9 @@
 # Mailigen
 
+[![Gem Version](https://badge.fury.io/rb/mailigen.png)](http://badge.fury.io/rb/mailigen)
+[![Build Status](https://travis-ci.org/artursbraucs/mailigen.png?branch=master)](https://travis-ci.org/artursbraucs/mailigen)
+[![Coverage Status](https://coveralls.io/repos/artursbraucs/mailigen/badge.png)](https://coveralls.io/r/artursbraucs/mailigen)
+
 API wrapper for mailigen.com .
 
 ## Installation
@@ -18,11 +22,36 @@ Or install it yourself as:
 
 ## Usage
 
+Create your mailigen instance and call 'call' method. First param - API method, seconds param - parameters (api_key included by default).
+
+Few examples:
+
     require "mailigen"
 
     mailigen = Mailigen::Api.new YOUR_MAILIGEN_API_KEY
+
+    # Ping to check apy key
     mailigen.call :ping # returns "Everything's Ok!" if API KEY is correct
 
+    # Creates a list
+    list_id = mailigen.call :listCreate, {title: "testListRspec", options: {permission_reminder: "Your in", notify_to: "foo@bar.com", subscription_notify: false}}
+
+    # Adds extra var to list
+    mailigen.call :listMergeVarAdd, {id: list_id, tag: "NAME", name: "Name of user"}
+
+    # Adds contacts batch to list
+    contacts_array_hash = {
+      "0" => {EMAIL: "foo@sample.com", EMAIL_TYPE: 'plain', NAME: 'Foo'}, 
+      "1" => {EMAIL: "bar@sample.com", EMAIL_TYPE: 'html',  NAME: 'Bar'}, 
+      "2" => {EMAIL: "foo@sample.com", EMAIL_TYPE: 'html',  NAME: 'Foo Dublicate'}
+    }
+    
+    resp = mailigen.call :listBatchSubscribe, {id: list_id, batch: contacts_array_hash, double_optin: false}
+
+    puts resp["success_count"] # Output should be 3
+
+For more: [Mailigen API documentation](http://dev.mailigen.com/display/AD/API+Documentation)
+
 ## Testing
 
 Gem using RSpec tests. You must add spec/keys/api.yml:

data/lib/mailigen.rb

@@ -10,6 +10,6 @@ module Mailigen
   @@api_host = "api.mailigen.com"
 
   mattr_accessor :api_version
-  @@api_version = "1.1"
+  @@api_version = "1.3"
 
 end

data/lib/mailigen/api.rb

@@ -1,7 +1,6 @@
 require 'uri'
 require 'net/http'
 require 'net/https'
-require "addressable/uri"
 require 'json'
 require 'active_support/core_ext/object'
 
@@ -11,10 +10,9 @@ module Mailigen
     attr_accessor :api_key, :secure
 
     # Initialize API wrapper. 
-    # Options:
     #
-    # api_key - from mailigen.com . Required.
-    # secure - use SSL. By default FALSE
+    # @param api_key - from mailigen.com . Required.
+    # @param secure - use SSL. By default FALSE
     # 
     def initialize api_key = nil, secure = false
       self.api_key = api_key
@@ -22,9 +20,20 @@ module Mailigen
       raise NoApiKeyError, "You must have Mailigen API key." unless self.api_key
     end
 
+    # Call Mailigen api method (Documented in http://dev.mailigen.com/display/AD/Mailigen+API )
+    #
+    # @param method - method name
+    # @param params - params if required for API
+    # 
+    # @return
+    # JSON, String data if all goes well.
+    # Exception if somethnigs goes wrong.
+    #
     def call method, params = {}
       url = "#{api_url}&method=#{method}"
+      
       params = {apikey: self.api_key}.merge params
+      
       resp = post_api(url, params)
       begin
         return JSON.parse(resp)
@@ -34,7 +43,7 @@ module Mailigen
     end
 
 
-    # Returns default api url with version included
+    # @return default api url with version included
     #
     def api_url
       protocol = self.secure ? "https" : "http"
@@ -45,12 +54,17 @@ module Mailigen
 
       # All api calls throught POST method.
       #
+      # @param url - url to post
+      # @param params - params in hash
+      #
+      # @return
+      # response body
       def post_api url, params
         uri = URI.parse(url)
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = self.secure
-
-        res = http.post(uri.request_uri, params.to_query)
+        form_params = params.to_query
+        res = http.post(uri.request_uri, form_params)
         res.body
       end
 

data/lib/mailigen/version.rb

@@ -1,3 +1,3 @@
 module Mailigen
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/mailigen.gemspec

@@ -19,7 +19,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport"
-  spec.add_dependency "addressable"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/spec/mailigen/api_spec.rb

@@ -31,44 +31,104 @@ describe Mailigen::Api do
 
         it "return url" do
           obj = Mailigen::Api.new "fookey", true
-          expect(obj.api_url).to eq("https://api.mailigen.com/1.1/?output=json")
+          expect(obj.api_url).to eq("https://api.mailigen.com/1.3/?output=json")
         end
 
       end
 
       context "default (unsecure)" do
         it "return url" do
-          expect(@invalid_mailigen.api_url).to eq("http://api.mailigen.com/1.1/?output=json")
+          expect(@invalid_mailigen.api_url).to eq("http://api.mailigen.com/1.3/?output=json")
         end
       end
 
     end
 
-    describe "call" do
+    if valid_mailigen_obj
+      describe "call" do
 
-      context "ping" do
+        describe "ping" do
 
-        context "invalide mailigen key" do
-          it "returns error" do
-            resp = @invalid_mailigen.call :ping
-            expect(resp["code"]).to eq(104)
-            expect(resp["error"]).to eq("Invalid Mailigen API Key: fookey")
+          context "invalide mailigen key" do
+            it "returns error" do
+              resp = @invalid_mailigen.call :ping
+              expect(resp["code"]).to eq(104)
+              expect(resp["error"]).to eq("Invalid Mailigen API Key: fookey")
+            end
           end
-        end
 
-        context "valide mailigen key" do
-          it "returns OK" do
-            resp = @mailigen.call :ping
-            expect(resp).to eq("Everything's Ok!")
+          context "valide mailigen key" do
+            it "returns OK" do
+              resp = @mailigen.call :ping
+              expect(resp).to eq("Everything's Ok!")
+            end
           end
+
         end
 
-      end
+        describe "lists" do
+          before(:all) do
+            # Creates list
+            create_list_params = {title: "testListRspec", options: {permission_reminder: "Your in", notify_to: "foo@bar.com", subscription_notify: false}}
+
+            resp = @mailigen.call(:listCreate, create_list_params)
+            @list_id = resp
+
+            @lists_with_email = {
+              "0" => {EMAIL: "foo@sample.com", EMAIL_TYPE: 'plain', NAME: 'Foo'}, 
+              "1" => {EMAIL: "bar@sample.com", EMAIL_TYPE: 'html',  NAME: 'Bar'}, 
+              "2" => {EMAIL: "foo@sample.com", EMAIL_TYPE: 'html',  NAME: 'Foo Dublicate'}
+            }
+          end
+          after(:all) do
+            # Removes list
+            @mailigen.call :listDelete, {id: @list_id}
+          end
+
+          context "createList" do
+            it "returns list id" do
+              expect(@list_id).not_to be(nil)
+            end
+          end
+
+          context "lists" do
+            it "returns lists containg testListRspec" do
+              exists = false
+              resp = @mailigen.call :lists
+              selected_lists = resp.select { |list| list["name"] == "testListRspec" }
+              expect(selected_lists.size).to eq(1)
+            end
+          end
+
+          context "listMergeVars" do
+            it "returns array with vars" do
+              resp = @mailigen.call :listMergeVars, {id: @list_id}
+              expect(resp.size).to eq(3)
+            end
+          end
+
+          context "listMergeVarAdd" do
+            it "returns true" do
+              params = {id: @list_id, tag: "FOO", name: "FooName"}
+              resp = @mailigen.call :listMergeVarAdd, params
+              expect(resp).to eq("true")
+            end
+          end
+
+          context "listBatchSubscribe" do
+            it "returns success count and fail count" do
+              # Add name var
+              params = {id: @list_id, tag: "NAME", name: "Name of user"}
+              resp = @mailigen.call :listMergeVarAdd, params
+
+              params = {id: @list_id, batch: @lists_with_email, double_optin: false}
+
+              resp = @mailigen.call :listBatchSubscribe, params
+              expect(resp["success_count"]).to eq(3)
+              expect(resp["error_count"]).to eq(0)
+            end
+          end
 
-      context "creates list" do
-        it "returns list id" do
-          resp = @mailigen.call :listCreate, {title: "testListRspec", options: {permission_reminder: "Your in", notify_to: "foo@bar.com", subscription_notify: false}}
-          expect(resp).not_to be(nil)
         end
       end
 

data/spec/mailigen_spec.rb

@@ -17,7 +17,7 @@ describe Mailigen do
     end
 
     it "has api_version" do
-      expect(Mailigen::api_version).to eq("1.1")
+      expect(Mailigen::api_version).to eq("1.3")
     end
 
   end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require 'mailigen'
-
 require 'rspec/autorun'
+require 'coveralls'
+
+Coveralls.wear!
 
 RSpec.configure do |config|
 end
@@ -11,5 +13,7 @@ end
 
 def valid_mailigen_obj
   hash = YAML.load(File.read("#{File.dirname(__FILE__)}/keys/api.yml"))
-  Mailigen::Api.new hash["mailigen"]["api_key"]
+  return Mailigen::Api.new hash["mailigen"]["api_key"]
+rescue
+  return nil
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailigen
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Arturs Braucs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-02 00:00:00.000000000 Z
+date: 2013-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,20 +24,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: addressable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -89,6 +75,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md