scrunchie 0.0.2
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +17 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +29 -0
- data/Rakefile +1 -0
- data/lib/scrunchie/version.rb +3 -0
- data/lib/scrunchie.rb +92 -0
- data/scrunchie.gemspec +23 -0
- metadata +86 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2013 Alan Schwarz
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,29 @@
|
|
1
|
+
# Scrunchie
|
2
|
+
|
3
|
+
TODO: Write a gem description
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
gem 'scrunchie'
|
10
|
+
|
11
|
+
And then execute:
|
12
|
+
|
13
|
+
$ bundle
|
14
|
+
|
15
|
+
Or install it yourself as:
|
16
|
+
|
17
|
+
$ gem install scrunchie
|
18
|
+
|
19
|
+
## Usage
|
20
|
+
|
21
|
+
TODO: Write usage instructions here
|
22
|
+
|
23
|
+
## Contributing
|
24
|
+
|
25
|
+
1. Fork it
|
26
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
27
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
28
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
29
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
data/lib/scrunchie.rb
ADDED
@@ -0,0 +1,92 @@
|
|
1
|
+
require "scrunchie/version"
|
2
|
+
require "faraday"
|
3
|
+
|
4
|
+
module Scrunchie
|
5
|
+
class Blast
|
6
|
+
attr_accessor :username, :api_key, :listname
|
7
|
+
|
8
|
+
# Take optional username, api_key, and listname and assign them to instance variables,
|
9
|
+
# or obtain those information from the environment if set.
|
10
|
+
def initialize(username=nil, api_key=nil, listname=nil)
|
11
|
+
@username = username || ENV['USERNAME']
|
12
|
+
@api_key = api_key || ENV['API_KEY']
|
13
|
+
@listname = listname || "Charm"
|
14
|
+
@obj = Faraday.new('https://api.elasticemail.com/lists')
|
15
|
+
@auth = { username: @username, api_key: @api_key }
|
16
|
+
end
|
17
|
+
|
18
|
+
# Create email in the database.
|
19
|
+
def create_contact(params={})
|
20
|
+
@obj.post('create-contact', @auth.merge(params))
|
21
|
+
end
|
22
|
+
|
23
|
+
# Delete email from the database.
|
24
|
+
def delete_contact(params={})
|
25
|
+
@obj.delete('delete-contact', @auth.merge(params))
|
26
|
+
end
|
27
|
+
|
28
|
+
# Create an empty list.
|
29
|
+
def create_list(params={})
|
30
|
+
@obj.post('create-list', @auth.merge(params))
|
31
|
+
end
|
32
|
+
|
33
|
+
# Delete a list, but does not remove contacts.
|
34
|
+
def delete_list(params={})
|
35
|
+
@obj.delete('delete', @auth.merge(params))
|
36
|
+
end
|
37
|
+
|
38
|
+
# Add an email already in the database to a listname. Returns error if no email.
|
39
|
+
def add_contact(params={})
|
40
|
+
@obj.put('add-contact', @auth.merge(params))
|
41
|
+
end
|
42
|
+
|
43
|
+
# Remove an email from a list, but does not delete the email.
|
44
|
+
def remove_contact(params={})
|
45
|
+
@obj.put('remove-contact', @auth.merge(params))
|
46
|
+
end
|
47
|
+
|
48
|
+
# This is not tested yet.
|
49
|
+
# Theoretically can upload a CSV of contact emails with optional fields
|
50
|
+
def upload_contacts(params={})
|
51
|
+
@obj.post('upload-contacts', @auth.merge(params)) # file: UploadIO.new(filepath, 'text/csv')
|
52
|
+
end
|
53
|
+
|
54
|
+
# Returns XML message constructed as { lists: { list: [{ name: "listname", contact: number }, { ... }] }.
|
55
|
+
def get_lists
|
56
|
+
@obj.get('get', @auth)
|
57
|
+
end
|
58
|
+
|
59
|
+
# Get a list of emails with possible firstname and lastname attributes from the list.
|
60
|
+
def get_contacts(params={})
|
61
|
+
@obj.get('get-contacts', @auth.merge(params))
|
62
|
+
end
|
63
|
+
|
64
|
+
# Get a CSV file containing all the contacts from @listname.
|
65
|
+
def download(format=nil)
|
66
|
+
if format == 'csv'
|
67
|
+
@obj.get('download', @auth.merge(format: format))
|
68
|
+
else
|
69
|
+
@obj.get('download', @auth)
|
70
|
+
end
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
module XML
|
75
|
+
class << self
|
76
|
+
# Attemps to parse the body, and rescue the ParseError to do the right thing
|
77
|
+
def parse(body)
|
78
|
+
MultiXml.parse(body)
|
79
|
+
rescue MultiXml::ParseError
|
80
|
+
convert_to_hash(body)
|
81
|
+
end
|
82
|
+
|
83
|
+
def convert_to_hash(body)
|
84
|
+
if body.start_with?("Error")
|
85
|
+
return { "Error" => body }
|
86
|
+
else
|
87
|
+
return { "Other" => body }
|
88
|
+
end
|
89
|
+
end
|
90
|
+
end
|
91
|
+
end
|
92
|
+
end
|
data/scrunchie.gemspec
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'scrunchie/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |gem|
|
7
|
+
gem.name = "scrunchie"
|
8
|
+
gem.version = Scrunchie::VERSION
|
9
|
+
gem.authors = ["Alan Schwarz"]
|
10
|
+
gem.email = ["alan.jcfs@gmail.com"]
|
11
|
+
gem.description = %q{A Contact List Management Wrapper for Elastic Email API}
|
12
|
+
gem.summary = %q{This wrapper is currently only for adding and removing contacts and lists}
|
13
|
+
gem.homepage = "http://github.com/alanjcfs/scrunchie"
|
14
|
+
|
15
|
+
gem.files = `git ls-files`.split($/)
|
16
|
+
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
|
17
|
+
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
|
18
|
+
gem.require_paths = ["lib"]
|
19
|
+
|
20
|
+
gem.add_dependency 'faraday'
|
21
|
+
gem.add_dependency 'multi_xml'
|
22
|
+
end
|
23
|
+
|
metadata
ADDED
@@ -0,0 +1,86 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: scrunchie
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.2
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Alan Schwarz
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2013-02-03 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: faraday
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ! '>='
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '0'
|
22
|
+
type: :runtime
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ! '>='
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '0'
|
30
|
+
- !ruby/object:Gem::Dependency
|
31
|
+
name: multi_xml
|
32
|
+
requirement: !ruby/object:Gem::Requirement
|
33
|
+
none: false
|
34
|
+
requirements:
|
35
|
+
- - ! '>='
|
36
|
+
- !ruby/object:Gem::Version
|
37
|
+
version: '0'
|
38
|
+
type: :runtime
|
39
|
+
prerelease: false
|
40
|
+
version_requirements: !ruby/object:Gem::Requirement
|
41
|
+
none: false
|
42
|
+
requirements:
|
43
|
+
- - ! '>='
|
44
|
+
- !ruby/object:Gem::Version
|
45
|
+
version: '0'
|
46
|
+
description: A Contact List Management Wrapper for Elastic Email API
|
47
|
+
email:
|
48
|
+
- alan.jcfs@gmail.com
|
49
|
+
executables: []
|
50
|
+
extensions: []
|
51
|
+
extra_rdoc_files: []
|
52
|
+
files:
|
53
|
+
- .gitignore
|
54
|
+
- Gemfile
|
55
|
+
- LICENSE.txt
|
56
|
+
- README.md
|
57
|
+
- Rakefile
|
58
|
+
- lib/scrunchie.rb
|
59
|
+
- lib/scrunchie/version.rb
|
60
|
+
- scrunchie.gemspec
|
61
|
+
homepage: http://github.com/alanjcfs/scrunchie
|
62
|
+
licenses: []
|
63
|
+
post_install_message:
|
64
|
+
rdoc_options: []
|
65
|
+
require_paths:
|
66
|
+
- lib
|
67
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
68
|
+
none: false
|
69
|
+
requirements:
|
70
|
+
- - ! '>='
|
71
|
+
- !ruby/object:Gem::Version
|
72
|
+
version: '0'
|
73
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
74
|
+
none: false
|
75
|
+
requirements:
|
76
|
+
- - ! '>='
|
77
|
+
- !ruby/object:Gem::Version
|
78
|
+
version: '0'
|
79
|
+
requirements: []
|
80
|
+
rubyforge_project:
|
81
|
+
rubygems_version: 1.8.23
|
82
|
+
signing_key:
|
83
|
+
specification_version: 3
|
84
|
+
summary: This wrapper is currently only for adding and removing contacts and lists
|
85
|
+
test_files: []
|
86
|
+
has_rdoc:
|