maropost_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3dec12bbcd69b4de22fecc58ef26326909abf416
+  data.tar.gz: 1bdaec6856c63cae7227cd0c0acc2fc18261f2fd
+SHA512:
+  metadata.gz: 925d3d0c7365978e72244f8d0e172c401fa54698314acce3d0a7d02bb2e176ab1e9bba04e9c88faf7f035def1590b5dac98855886df4f5b90896f281385ce286
+  data.tar.gz: 11300e4d906d9994979425e78613e867078d317272a5f5c201acc0a31dd8401d77a8bb375b3a7afd78a0f69dc148860e93777694c5fdc9bea987d6105aea0cf6

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.*.swp
+.*.swo

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in maropost_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Hossein Toussi, Haidar Muhammad
+
+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

@@ -0,0 +1,50 @@
+# MaropostApi
+
+A simple ruby wrapper for Maropost (http://maropost.com/) API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'maropost_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install maropost_api
+
+## Usage
+
+Initialize a Client object with `client = MaropostApi::Client.new(auth_token: '<TOKEN>', account_number: '<ID>')`
+And here are the methods available:
+
+``` ruby
+# To find a contact by email:
+client.contacts.add_to_list(email: 'test@example.com')
+
+# To add a contact to a list
+client.contacts.add_to_list(list_ids: '<id>', params: {email: 'test@example.com'})
+
+# To update a contact
+client.contacts.update(list_ids: '<id>', params: {email: 'test@example.com', first_name: 'test-updated'})
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hosseintoussi/maropost_api.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  exec "irb -r maropost_api -I ./lib"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'maropost_api'
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/maropost_api.rb

@@ -0,0 +1,10 @@
+require "hashie"
+require "maropost_api/version"
+require "maropost_api/request"
+require "maropost_api/errors"
+require "maropost_api/response"
+require "maropost_api/client"
+require "maropost_api/contacts"
+
+module MaropostApi
+end

data/lib/maropost_api/client.rb

@@ -0,0 +1,11 @@
+module MaropostApi
+  class Client
+    def initialize(auth_token:, account_number:)
+      @request = Request.new(auth_token: auth_token, account_number: account_number)
+    end
+
+    def contacts
+      @contacts ||= Contacts.new(request: @request)
+    end
+  end
+end

data/lib/maropost_api/contacts.rb

@@ -0,0 +1,18 @@
+module MaropostApi
+  class Contacts
+    def initialize(request:)
+      @request = request
+    end
+
+    def find_by_email(email:)
+      response = @request.get(endpoint: "contacts/email.json?contact[email]=#{email}")
+      Response.new(response: response).call
+    end
+
+    def add_to_list(list_ids: "", params:)
+      response = @request.post(endpoint: "contacts.json?list_ids=#{list_ids}", params: params)
+      Response.new(response: response).call
+    end
+    alias_method :update, :add_to_list
+  end
+end

data/lib/maropost_api/errors.rb

@@ -0,0 +1,8 @@
+module MaropostApi
+  class Errors < StandardError; end
+  class InternalServerError < Errors; end
+  class BadRequest < Errors; end
+  class Unauthorized < Errors; end
+  class NotFound < Errors; end
+  class UnprocessableEntity < Errors; end
+end

data/lib/maropost_api/request.rb

@@ -0,0 +1,41 @@
+require 'httparty'
+
+module MaropostApi
+  class Request
+    include HTTParty
+
+    def initialize(auth_token:, account_number:)
+      @auth_token = auth_token
+      @account_number = account_number
+      set_default_config
+    end
+
+    def post(endpoint:, params: {})
+      self.class.post(uri(endpoint), payload(params))
+    end
+
+    def get(endpoint:, params: {})
+      self.class.get(uri(endpoint), payload(params))
+    end
+
+    private
+
+    def set_default_config
+      @base_uri = "http://api.maropost.com/accounts/#{@account_number}"
+      @default_params = { auth_token: @auth_token }
+    end
+
+    def uri(endpoint)
+      "#{@base_uri}/#{endpoint}"
+    end
+
+    def payload(params)
+      { body: merge_auth_token(params).to_json,
+        headers: { 'Content-Type' => 'application/json' } }
+    end
+
+    def merge_auth_token(params)
+      @default_params.merge(params)
+    end
+  end
+end

data/lib/maropost_api/response.rb

@@ -0,0 +1,24 @@
+module MaropostApi
+  class Response
+    def initialize(response: {})
+      @response = response
+    end
+
+    def call
+      case @response.code
+      when 400
+        raise BadRequest.new
+      when 401...402
+        raise Unauthorized.new
+      when 404
+        raise  NotFound.new
+      when 422
+        raise UnprocessableEntity.new
+      when 500
+        raise InternalServerError.new
+      else
+        Hashie::Mash.new(@response)
+      end
+    end
+  end
+end

data/lib/maropost_api/version.rb

@@ -0,0 +1,3 @@
+module MaropostApi
+  VERSION = '0.1.0'
+end

data/maropost_api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "maropost_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "maropost_api"
+  spec.version       = MaropostApi::VERSION
+  spec.authors       = ["Hossein Toussi", "Haidar Muhammad"]
+  spec.email         = ["saeed.toussi@yahoo.com", "haidar.muhammad@gmail.com"]
+
+  spec.summary       = "Wrapper gem for Maropost API"
+  spec.homepage      = "https://github.com/hosseintoussi/maropost_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
+
+  spec.add_runtime_dependency "httparty"
+  spec.add_runtime_dependency "hashie"
+end

data/readme.md

@@ -0,0 +1,50 @@
+# MaropostApi
+
+A simple ruby wrapper for Maropost (http://maropost.com/) API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'maropost_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install maropost_api
+
+## Usage
+
+Initialize a Client object with `client = MaropostApi::Client.new(auth_token: '<TOKEN>', account_number: '<ID>')`
+And here are the methods available:
+
+``` ruby
+# To find a contact by email:
+client.contacts.add_to_list(email: 'test@example.com')
+
+# To add a contact to a list
+client.contacts.add_to_list(list_ids: '<id>', params: {email: 'test@example.com'})
+
+# To update a contact
+client.contacts.update(list_ids: '<id>', params: {email: 'test@example.com', first_name: 'test-updated'})
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hosseintoussi/maropost_api.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: maropost_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hossein Toussi
+- Haidar Muhammad
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: hashie
+  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'
+description: 
+email:
+- saeed.toussi@yahoo.com
+- haidar.muhammad@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/maropost_api.rb
+- lib/maropost_api/client.rb
+- lib/maropost_api/contacts.rb
+- lib/maropost_api/errors.rb
+- lib/maropost_api/request.rb
+- lib/maropost_api/response.rb
+- lib/maropost_api/version.rb
+- maropost_api.gemspec
+- readme.md
+homepage: https://github.com/hosseintoussi/maropost_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Wrapper gem for Maropost API
+test_files: []