vertigo 0.0.1.b → 0.0.1.d
Sign up to get free protection for your applications and to get access to all the features.
- data/Gemfile.lock +1 -1
- data/README.rdoc +22 -8
- data/TODO.rdoc +1 -1
- data/lib/vertigo.rb +3 -0
- data/lib/vertigo/client.rb +2 -1
- data/lib/vertigo/version.rb +1 -1
- data/vertigo.gemspec +2 -2
- metadata +6 -6
data/Gemfile.lock
CHANGED
data/README.rdoc
CHANGED
@@ -1,11 +1,12 @@
|
|
1
1
|
= Vertigo
|
2
2
|
|
3
|
-
|
3
|
+
Is the VerticalResponse API making you dizzy?
|
4
4
|
|
5
|
-
Vertigo makes working with the VerticalResponse SOAP API much more Ruby-like. It manages your session_id, as well as letting you write methods as launch_email_campaign rather than launchEmailCampaign, and use symbols as keys rather than strings.
|
5
|
+
Vertigo is a simple Ruby wrapper that makes working with the VerticalResponse SOAP API much more Ruby-like. It manages your session_id, as well as letting you write methods as launch_email_campaign rather than launchEmailCampaign, and use symbols as keys rather than strings.
|
6
6
|
|
7
7
|
Author: Benjamin Oakes <hello@benjaminoakes.com>, @benjaminoakes
|
8
8
|
|
9
|
+
http://stillmaintained.com/benjaminoakes/vertigo.png
|
9
10
|
http://travis-ci.org/benjaminoakes/vertigo.png ({More info}[http://travis-ci.org/benjaminoakes/vertigo])
|
10
11
|
|
11
12
|
== Installation
|
@@ -20,27 +21,40 @@ If you are unlucky enough not to be using Bundler:
|
|
20
21
|
|
21
22
|
== Usage
|
22
23
|
|
23
|
-
Basic
|
24
|
+
Basic example:
|
24
25
|
|
25
26
|
require 'vertigo'
|
26
27
|
|
27
|
-
session_duration_minutes = 4
|
28
28
|
client = Vertigo::Client.new('username', 'password', :duration_minutes => 5)
|
29
29
|
|
30
30
|
# Launch a campaign whose ID you already know:
|
31
|
-
client.launch_email_campaign(:campaign_id =>
|
31
|
+
client.launch_email_campaign(:campaign_id => 123456)
|
32
32
|
|
33
|
-
For more info, please see {Vertigo::Client}
|
33
|
+
For more info, please see {Vertigo::Client}[http://rubydoc.info/gems/vertigo].
|
34
34
|
|
35
35
|
== Compatibility
|
36
36
|
|
37
|
+
* Requires Ruby 1.8.7 (because of dependency on soap4r)
|
37
38
|
* Written against the 2011.08.10 deploy of the VerticalResponse API "v1.0". More information: http://developers.verticalresponse.com/api/soap/developers-reference/articles/verticalresponse-api-update-for-august-2011/
|
38
39
|
|
39
40
|
== Contributing
|
40
41
|
|
41
|
-
|
42
|
+
Wow, you want to contribute? That's awesome! Thanks!
|
42
43
|
|
43
|
-
|
44
|
+
To set up your development environment, please run:
|
45
|
+
|
46
|
+
bash dev-setup.sh
|
47
|
+
|
48
|
+
Among other things, that command makes sure you have run `git flow init` (which makes managing contributions easier). Please develop on the +develop+ branch. When you have something you'd like to share, send a pull request to @benjaminoakes.
|
49
|
+
|
50
|
+
=== Notes on Gems
|
51
|
+
|
52
|
+
* This is a Ruby Gem, built using Bundler. For a walkthrough of how that works, see http://railscasts.com/episodes/245-new-gem-with-bundler
|
53
|
+
* You get some rake tasks for free (see `rake --tasks`) to help with building and installing
|
54
|
+
|
55
|
+
=== Misc.
|
56
|
+
|
57
|
+
When writing documentation, this is handy:
|
44
58
|
|
45
59
|
bundle exec yard server --reload
|
46
60
|
|
data/TODO.rdoc
CHANGED
@@ -1 +1 @@
|
|
1
|
-
* The "soap4r" gem does not play very well with Ruby 1.9.2. Migrate to a new SOAP interface.
|
1
|
+
* The "soap4r" gem does not play very well with Ruby 1.9.2. Migrate to a new SOAP interface (e.g. Savon http://savonrb.com/)
|
data/lib/vertigo.rb
CHANGED
data/lib/vertigo/client.rb
CHANGED
@@ -82,7 +82,8 @@ private
|
|
82
82
|
#
|
83
83
|
# @param [Hash, Array, Object] original
|
84
84
|
def stringify_keys(original)
|
85
|
-
|
85
|
+
# I might like to do more duck typing here, but we're making a Hash or Array whether or not it actually was one originally.
|
86
|
+
if original.kind_of?(Hash)
|
86
87
|
Hash[original.map { |key, val| [key.to_s, stringify_keys(val)] }]
|
87
88
|
elsif original.kind_of?(Array)
|
88
89
|
original.map { |val| stringify_keys(val) }
|
data/lib/vertigo/version.rb
CHANGED
data/vertigo.gemspec
CHANGED
@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
|
|
8
8
|
s.authors = ["Benjamin Oakes"]
|
9
9
|
s.email = ["boakes@hedgeye.com"]
|
10
10
|
s.homepage = ""
|
11
|
-
s.summary = %q{
|
12
|
-
s.description =
|
11
|
+
s.summary = %q{Is the VerticalResponse API making you dizzy?}
|
12
|
+
s.description = s.summary
|
13
13
|
|
14
14
|
s.rubyforge_project = "vertigo"
|
15
15
|
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: vertigo
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
hash:
|
4
|
+
hash: 45
|
5
5
|
prerelease: 6
|
6
6
|
segments:
|
7
7
|
- 0
|
8
8
|
- 0
|
9
9
|
- 1
|
10
|
-
-
|
11
|
-
version: 0.0.1.
|
10
|
+
- d
|
11
|
+
version: 0.0.1.d
|
12
12
|
platform: ruby
|
13
13
|
authors:
|
14
14
|
- Benjamin Oakes
|
@@ -16,7 +16,7 @@ autorequire:
|
|
16
16
|
bindir: bin
|
17
17
|
cert_chain: []
|
18
18
|
|
19
|
-
date: 2011-08-
|
19
|
+
date: 2011-08-29 00:00:00 -04:00
|
20
20
|
default_executable:
|
21
21
|
dependencies:
|
22
22
|
- !ruby/object:Gem::Dependency
|
@@ -99,7 +99,7 @@ dependencies:
|
|
99
99
|
version: 1.0.0
|
100
100
|
type: :development
|
101
101
|
version_requirements: *id005
|
102
|
-
description:
|
102
|
+
description: Is the VerticalResponse API making you dizzy?
|
103
103
|
email:
|
104
104
|
- boakes@hedgeye.com
|
105
105
|
executables: []
|
@@ -159,7 +159,7 @@ rubyforge_project: vertigo
|
|
159
159
|
rubygems_version: 1.6.2
|
160
160
|
signing_key:
|
161
161
|
specification_version: 3
|
162
|
-
summary:
|
162
|
+
summary: Is the VerticalResponse API making you dizzy?
|
163
163
|
test_files:
|
164
164
|
- spec/lib/vertigo/client_spec.rb
|
165
165
|
- spec/spec_helper.rb
|