maropost_api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3dec12bbcd69b4de22fecc58ef26326909abf416
-  data.tar.gz: 1bdaec6856c63cae7227cd0c0acc2fc18261f2fd
+  metadata.gz: 719f8e25c9902556c46859bbf07004cfa6a78dd2
+  data.tar.gz: 8b518df8320edf648deed400f8fe72a9570f8153
 SHA512:
-  metadata.gz: 925d3d0c7365978e72244f8d0e172c401fa54698314acce3d0a7d02bb2e176ab1e9bba04e9c88faf7f035def1590b5dac98855886df4f5b90896f281385ce286
-  data.tar.gz: 11300e4d906d9994979425e78613e867078d317272a5f5c201acc0a31dd8401d77a8bb375b3a7afd78a0f69dc148860e93777694c5fdc9bea987d6105aea0cf6
+  metadata.gz: fd9d04ce6243580b1de26463ad156bbe6eab222750b956251fab2a7da3bd0e619bfdcf6680b7d731762664ca364960c99dabe20354337193151bd072fcb982a4
+  data.tar.gz: 801292ed6c319e945e77b1bc30bbd1afcfc9b2454f60cbec168da6ed38a384588dff7e89eeb06147d37a5f7402b0d21209503d5f18ec53926fab6f5e9e1e85fa

data/lib/maropost_api.rb

@@ -3,8 +3,11 @@ require "maropost_api/version"
 require "maropost_api/request"
 require "maropost_api/errors"
 require "maropost_api/response"
+require "maropost_api/parser/entity_parser"
+require "maropost_api/parser/message_body_parser"
 require "maropost_api/client"
 require "maropost_api/contacts"
+require "maropost_api/workflows"
 
 module MaropostApi
 end

data/lib/maropost_api/client.rb

@@ -7,5 +7,9 @@ module MaropostApi
     def contacts
       @contacts ||= Contacts.new(request: @request)
     end
+
+    def workflows
+      @workflows ||= Workflows.new(request: @request)
+    end
   end
 end

data/lib/maropost_api/contacts.rb

@@ -2,17 +2,32 @@ module MaropostApi
   class Contacts
     def initialize(request:)
       @request = request
+      @parser = Parser::EntityParser.new
     end
 
     def find_by_email(email:)
-      response = @request.get(endpoint: "contacts/email.json?contact[email]=#{email}")
-      Response.new(response: response).call
+      response = @request.get(endpoint: "/contacts/email.json?contact[email]=#{email}")
+      Response.new(response: response, parser: @parser).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
+    def add_to_list(list_ids:, params:)
+      response = @request.post(endpoint: "/contacts.json?list_ids=#{list_ids}", params: params)
+      Response.new(response: response, parser: @parser).call
+    end
+
+    def create(params:)
+      response = @request.post(endpoint: "/contacts.json", params: params)
+      Response.new(response: response, parser: @parser).call
+    end
+
+    def update(contact_id:, params:)
+      response = @request.put(endpoint: "/contacts/#{contact_id}.json", params: params)
+      Response.new(response: response, parser: @parser).call
+    end
+
+    def unsubscribe_all_lists(email:)
+      response = @request.put(endpoint: "/contacts/unsubscribe_all.json?contact[email]=#{email}")
+      Response.new(response: response, parser: @parser).call
     end
-    alias_method :update, :add_to_list
   end
 end

data/lib/maropost_api/parser/entity_parser.rb

@@ -0,0 +1,9 @@
+module MaropostApi
+  module Parser
+    class EntityParser
+      def call(response)
+        Hashie::Mash.new(response)
+      end
+    end
+  end
+end

data/lib/maropost_api/parser/message_body_parser.rb

@@ -0,0 +1,9 @@
+module MaropostApi
+  module Parser
+    class MessageBodyParser
+      def call(response)
+        Hashie::Mash.new(message: response.body)
+      end
+    end
+  end
+end

data/lib/maropost_api/request.rb

@@ -18,6 +18,10 @@ module MaropostApi
       self.class.get(uri(endpoint), payload(params))
     end
 
+    def put(endpoint:, params: {})
+      self.class.put(uri(endpoint), payload(params))
+    end
+
     private
 
     def set_default_config
@@ -26,7 +30,7 @@ module MaropostApi
     end
 
     def uri(endpoint)
-      "#{@base_uri}/#{endpoint}"
+      Addressable::URI.encode("#{@base_uri}#{endpoint}")
     end
 
     def payload(params)

data/lib/maropost_api/response.rb

@@ -1,7 +1,8 @@
 module MaropostApi
   class Response
-    def initialize(response: {})
+    def initialize(response: {}, parser:)
       @response = response
+      @parser = parser
     end
 
     def call
@@ -17,7 +18,7 @@ module MaropostApi
       when 500
         raise InternalServerError.new
       else
-        Hashie::Mash.new(@response)
+        @parser.call(@response)
       end
     end
   end

data/lib/maropost_api/version.rb

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

data/lib/maropost_api/workflows.rb

@@ -0,0 +1,24 @@
+module MaropostApi
+  class Workflows
+    def initialize(request:)
+      @request = request
+      @body_parser = Parser::MessageBodyParser.new
+      @entity_parser = Parser::EntityParser.new
+    end
+
+    def stop(workflow_id:, contact_id:)
+      response = @request.put(endpoint: "/workflows/#{workflow_id}/stop/#{contact_id}.json")
+      Response.new(response: response, parser: @body_parser).call
+    end
+
+    def start(workflow_id:, contact_id:)
+      response = @request.put(endpoint: "/workflows/#{workflow_id}/start/#{contact_id}.json")
+      Response.new(response: response, parser: @body_parser).call
+    end
+
+    def reset(workflow_id:, contact_id:)
+      response = @request.put(endpoint: "/workflows/#{workflow_id}/reset/#{contact_id}.json")
+      Response.new(response: response, parser: @entity_parser).call
+    end
+  end
+end

data/maropost_api.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "httparty"
   spec.add_runtime_dependency "hashie"
+  spec.add_runtime_dependency "addressable"
 end

data/readme.md

@@ -20,18 +20,37 @@ Or install it yourself as:
 
 ## Usage
 
-Initialize a Client object with `client = MaropostApi::Client.new(auth_token: '<TOKEN>', account_number: '<ID>')`
 And here are the methods available:
 
 ``` ruby
+# Initialize a Client object with:
+client = MaropostApi::Client.new(auth_token: '<TOKEN>', account_number: '<ID>')
+
+# And use the client to perform available functionalities.
+
 # To find a contact by email:
-client.contacts.add_to_list(email: 'test@example.com')
+client.contacts.find_by_email(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 create a contact without any lists
+client.contacts.create(params: {email: 'test@example.com'})
+
 # To update a contact
-client.contacts.update(list_ids: '<id>', params: {email: 'test@example.com', first_name: 'test-updated'})
+client.contacts.update(contact_id: '<id>', params: {email: 'test@example.com', first_name: 'test-updated'})
+
+# To unsubscribe a contact from all lists
+client.contacts.unsubscribe_all_lists(email: 'test@example.com')
+
+# To start a workflow for a contact
+client.workflows.start(workflow_id: '<workflow_id>', contact_id: '<contact_id>')
+
+# To stop a workflow for a contact
+client.workflows.stop(workflow_id: '<workflow_id>', contact_id: '<contact_id>')
+
+# To reset a workflow for a contact
+client.workflows.reset(workflow_id: '<workflow_id>', contact_id: '<contact_id>')
 ```
 
 ## Development

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maropost_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Hossein Toussi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-13 00:00:00.000000000 Z
+date: 2016-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,6 +123,20 @@ 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'
 description: 
 email:
 - saeed.toussi@yahoo.com
@@ -135,7 +149,6 @@ files:
 - ".rspec"
 - Gemfile
 - LICENSE.txt
-- README.md
 - Rakefile
 - bin/console
 - bin/setup
@@ -143,9 +156,12 @@ files:
 - lib/maropost_api/client.rb
 - lib/maropost_api/contacts.rb
 - lib/maropost_api/errors.rb
+- lib/maropost_api/parser/entity_parser.rb
+- lib/maropost_api/parser/message_body_parser.rb
 - lib/maropost_api/request.rb
 - lib/maropost_api/response.rb
 - lib/maropost_api/version.rb
+- lib/maropost_api/workflows.rb
 - maropost_api.gemspec
 - readme.md
 homepage: https://github.com/hosseintoussi/maropost_api

data/README.md

@@ -1,50 +0,0 @@
-# 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).