mailflow-ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73f1f3042f8801bba568a43951114904f8c6f287
-  data.tar.gz: b6ed8ff54bedf61f2d734a92aa1116529bd274a2
+  metadata.gz: ce09fe7f6df53a28394ca9924919c22a2ad87200
+  data.tar.gz: 659b72f988696c8ba0431fd3266cfa6d0e6a9a24
 SHA512:
-  metadata.gz: 42f2caa96efd688b31de2e0d202a0ef01328f9ab8fde1a5c68b4af96017870bed26dcd27606b00deee96e576e110d40880f6d648ddddae17174f6d1db76a7972
-  data.tar.gz: ee3a1999bfdde6f07b03c26c258f5f4be8d088eb4630f4d5fdb5c0548f8ac5c826f2ff3773ef7a112dbf8b53a5a5fb11030c94e9cff2a9256a8b57a993d9864c
+  metadata.gz: 90892ce44418384be79a913c57c860d548560a7edff74e166c8494b5396a0d676571ddaf860a5230124a4b2a61125dbf4276e85b343741fd7955e93a8022f468
+  data.tar.gz: ccc65993807d6799120056392ac4c96de016adab355edc47eda6c518259eec39b5298a238c5b807e142bbbb6912b152780ade54c0199639017cadb624a963c96

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 TODO: Write your name
+Copyright (c) 2016 Mailflow Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,3 +1,114 @@
-### TODO
+# Mailflow Ruby library
 
-* Write a readme
+This is Mailflow's official Ruby library. It allows convenient access to the Mailflow API, which allows you to:
+
+* Get, create and delete contacts
+* Update attributes for a specific contact
+* Tag and untag a specific contact
+* Trigger sequences on contact tag
+
+## Getting started
+
+### Install the gem
+
+    gem install mailflow-ruby
+
+### Provide API credentials
+
+You can find your API credentials in the [Integrations section](https://mailflow.com/integrations/mailflow) of the Mailflow app.
+
+```ruby
+require 'mailflow-ruby'
+
+Mailflow.setup('API_KEY', 'SECRET_KEY')
+```
+
+### List all contacts
+
+```ruby
+Mailflow::Contact.list
+```
+
+## Contacts
+
+#### Basic contact operations
+
+
+Get a contact by email address or contact ID:
+
+```ruby
+Mailflow::Contact.get({email: 'foo@example.com'})
+Mailflow::Contact.get({contact_id: 'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11'})
+```
+
+
+Create an unconfirmed contact (this will send the contact an opt-in email):
+
+```ruby
+Mailflow::Contact.create({email: 'foo@example.com'})
+```
+
+
+Create a confirmed contact (and don't send an opt-in email)
+
+```ruby
+Mailflow::Contact.create({email: 'foo@example.com', confirmed: true})
+```
+
+
+### Contact tag operations
+
+
+List a contact's tags:
+
+```ruby
+contact = Mailflow::Contact.get({email: 'foo@example.com'})
+contact.tags
+```
+
+
+Tag a contact (accepts an array only):
+
+```ruby
+contact = Mailflow::Contact.get({email: 'foo@example.com'})
+contact.tag(['Foo', 'Bar'])
+```
+
+
+Tag a contact and trigger any relevant sequences:
+
+```ruby
+contact = Mailflow::Contact.get({email: 'foo@example.com'})
+contact.tag(['Foo', 'Bar'], true)
+```
+
+
+Untag a contact (accepts an array only):
+
+```ruby
+contact = Mailflow::Contact.get({email: 'foo@example.com'})
+contact.untag(['Foo', 'Bar'])
+```
+
+
+### Contact attribute operations
+
+
+List a contact's attributes:
+
+```ruby
+contact = Mailflow::Contact.get({email: 'foo@example.com'})
+contact.attributes
+```
+
+
+Set attributes on a contact:
+
+```ruby
+contact = Mailflow::Contact.get({email: 'foo@example.com'})
+contact.set_attributes({'First name' => 'Foo', 'Last name' => 'Bar' })
+```
+
+## More information
+
+Contact support@mailflow.com for more information.

data/lib/mailflow-ruby/attribute.rb

@@ -46,4 +46,4 @@ module Mailflow
 
   end
 
-end
+end

data/lib/mailflow-ruby/client.rb

@@ -8,15 +8,16 @@ module Mailflow
   class << self
     attr_accessor :test_mode
   end
-  
+
   class Client
 
     include Mailflow::APIOperations
 
     def self.test
-      get('test')
+      response = get_request('test')
+      return {status: response.code}
     end
 
   end
 
-end
+end

data/lib/mailflow-ruby/contact.rb

@@ -49,12 +49,14 @@ module Mailflow
       Mailflow::Tag.list(contact_id: id)
     end
 
-    def tag(tags)
-      Mailflow::Tag.create(tags, {contact_id: id})
+    def tag(tags, trigger = false)
+      Mailflow::Tag.create(tags, {contact_id: id}, trigger)
+      self
     end
 
     def untag(tags)
       Mailflow::Tag.untag(tags, {contact_id: id})
+      self
     end
 
     def attributes
@@ -67,8 +69,9 @@ module Mailflow
       end
 
       Mailflow::Attribute.update(attributes, {contact_id: id})
+      self
     end
 
   end
 
-end
+end

data/lib/mailflow-ruby/version.rb

@@ -1,3 +1,3 @@
 module Mailflow
-  VERSION = '0.1.0'
-end
+  VERSION = '0.1.1'
+end

data/lib/mailflow-ruby.rb

@@ -12,6 +12,7 @@ module Mailflow
 
   def self.setup(api_key, api_secret)
     Mailflow.configure({api_key: api_key, api_secret: api_secret})
+    true
   end
 
-end
+end

data/mailflow-ruby.gemspec

@@ -6,11 +6,11 @@ require 'mailflow-ruby/version.rb'
 Gem::Specification.new do |spec|
   spec.name          = "mailflow-ruby"
   spec.version       = Mailflow::VERSION
-  spec.authors       = ["Chris Wickett", "Alex Rowan"]
-  spec.email         = ["admin@mailflow.com"]
+  spec.authors       = ["Mailflow"]
+  spec.email         = ["support@mailflow.com"]
 
-  spec.summary       = "Mailflow's Ruby API Wrapper"
-  spec.homepage      = "https://mailflow.com"
+  spec.summary       = "The official Ruby library for Mailflow's API"
+  spec.homepage      = "https://mailflow.com/support/api-reference"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Gems for production
-  spec.add_dependency "httparty"
-  spec.add_dependency "hashie"
-  
+  spec.add_dependency "httparty", "~> 0.13.5"
+  spec.add_dependency "hashie", "~> 3.4.2"
+
   # Gems for dev
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rspec"

metadata

@@ -1,44 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: mailflow-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
-- Chris Wickett
-- Alex Rowan
+- Mailflow
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-29 00:00:00.000000000 Z
+date: 2016-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.5
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.4.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -111,7 +110,7 @@ dependencies:
         version: '0'
 description: 
 email:
-- admin@mailflow.com
+- support@mailflow.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -133,8 +132,9 @@ files:
 - lib/mailflow-ruby/contact.rb
 - lib/mailflow-ruby/tag.rb
 - lib/mailflow-ruby/version.rb
+- mailflow-ruby-0.1.0.gem
 - mailflow-ruby.gemspec
-homepage: https://mailflow.com
+homepage: https://mailflow.com/support/api-reference
 licenses:
 - MIT
 metadata: {}
@@ -157,5 +157,5 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Mailflow's Ruby API Wrapper
+summary: The official Ruby library for Mailflow's API
 test_files: []