responsys-api 0.0.5 → 0.0.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +8 -8
  2. data/README.md +18 -21
  3. data/responsys-api.gemspec +2 -2
  4. metadata +6 -6
checksums.yaml CHANGED
@@ -1,15 +1,15 @@
1
1
  ---
2
2
  !binary "U0hBMQ==":
3
3
  metadata.gz: !binary |-
4
- OTNjZTgyNjk2Zjk4OTgyY2E5MzYwMTgwZDk1MjUzZWE3ZDNiYzI1Yg==
4
+ Mzc2Y2Y3OGYxOTEyNWEwNjgzYzU4NDQ3MDUyMDE1NWEzMDRjNWExYw==
5
5
  data.tar.gz: !binary |-
6
- ZjZmMDFhMThmYmE3N2NkOTM2YjAyNzA0MDEwMDUyZjEwOWE3ZGI1Mg==
6
+ YmUwOTBhODNjZDI4NjQ5MmNiZTdlNTdiYjc3ODZkNWRmZWEyZDViZA==
7
7
  SHA512:
8
8
  metadata.gz: !binary |-
9
- ZGI2ZGQxNDAxM2QyMmY4ZjJhNTIyNmMyZjhkY2MwMWMyNGU0NDgyNTY2MWMz
10
- MGVlNWQ4NDg0NWQ0N2M1M2FhODg1MjI3M2JjMjI3MjNjODU3M2E3YjJhODVi
11
- MzkzZjQwZDk5OWY5NTI2MzgzMzZhNDQwYjdkNmM2MjIzZGE3N2M=
9
+ NmU1YjgwYjZhMGY2ZGI3YTRiNjJkNGY4YWQyMDBkOWJiYjE3MmRmZTkwMmY0
10
+ NjdhOTJlY2MxMDY2NzFmODRhNmMyYjFhZmRmOWQyYWNkODk0NTAwMTYxMWVk
11
+ YWM2NmZiYjdkMzY4NzgzMDFjNTUzOWZhZTA1OTJmYWMyYjI1ZWE=
12
12
  data.tar.gz: !binary |-
13
- OTAwYjkyMjEzYTk5ODkzYmU1YmQ5MDVlY2MwMWE3ZmQxNzBiZTkxOThhYWVh
14
- NWQ1N2E1MDcxMTdhMTBkMWM1Mzc0YjRhYmQ3MzZiYzEwNzFmMzY1N2VkNDRh
15
- NTc5MzljZjY2ZDMyYmFlNTk2ODE0OGVmZGI2ZTgwMGVlOGY1YmI=
13
+ MDg4YzVlZTliMTdjMmZiYjBkM2Q3ZGE0YWQwMGI5ODBhNmViZTJmNGJhOGMw
14
+ NGFhYjdhNGUwYThkMTRkOWI2MmY1NDI5YWVkNzMzOGM2MWI2YmQ1NjgyY2Y4
15
+ MzFhODNmMTZlZmU1OTk2NjE5YTAyYTE0Y2JkY2NiYTY3ODljY2E=
data/README.md CHANGED
@@ -1,23 +1,23 @@
1
1
  # ResponsysApi
2
2
 
3
- A gem to help you communicate to the Responsys Interact SOAP API. Currently supporting version 6.20.
3
+ A gem to help you communicate to the Responsys Interact SOAP API. Currently working of Responsys Interact version 6.20.
4
4
 
5
5
  ## Documentation
6
6
 
7
- Have a look at the [wiki](https://github.com/dandemeyere/responsys-api/wiki) to understand how it works as well as special tips specially prepared for you ! If you have any questions or if you want to report a bug please create an [issue](https://github.com/dandemeyere/responsys-api/issues).
7
+ Have a look at our [wiki](https://github.com/dandemeyere/responsys-api/wiki) to understand the functionality this gem offers, how to use it, and some tips to help you avoid the same mistakes we ran into! If you have any questions or if you want to report a bug please create an [issue](https://github.com/dandemeyere/responsys-api/issues).
8
8
 
9
9
  ## Installation
10
10
 
11
11
  Add this line to your application"s Gemfile:
12
12
 
13
- gem "responsys-api", "~> 0.0.4"
13
+ gem "responsys-api", "~> 0.0.6"
14
14
 
15
15
  Or install it locally with:
16
16
 
17
17
  $ gem install responsys-api
18
18
 
19
19
  ## Usage
20
- ### Configuration
20
+ ### Configuration
21
21
 
22
22
  ```ruby
23
23
  # Configure ResponsysApi in your initializers (config/initializers/responsys_api.rb):
@@ -57,15 +57,15 @@ list = Responsys::Api::Object::InteractObject.new("the_folder_containing_the_lis
57
57
  # The Member (or "user" for the example) record to update
58
58
  member = Responsys::Member.new('user@email.com')
59
59
 
60
- # Add the user to the list if he is not present.
61
- unless member.present_in_list?(list)
62
- puts "New user. Let's add it"
60
+ # Add the user to the list if he/she is not already present.
61
+ unless member.present_in_list?(list)
62
+ puts "New user add to list functionality."
63
63
  member.add_to_list(list)
64
64
  else
65
65
  puts "The user is in the list"
66
66
  end
67
67
 
68
- # Subscribe the user if he hasn't subscribed yet
68
+ # Subscribe the user if he/she hasn't already subscribed.
69
69
  unless member.subscribed?(list)
70
70
  puts "Subscribing the user to the list"
71
71
  member.subscribe(list)
@@ -74,10 +74,10 @@ else
74
74
  end
75
75
 
76
76
  # Check the member has a subscribed status
77
- puts member.subscribed?(list) ? "#{member.email} has subscribed to #{list.object_name}" : "An error happened"
77
+ puts member.subscribed?(list) ? "#{member.email} has subscribed to #{list.object_name}" : "An error ocurred"
78
78
  ```
79
79
  ### Session
80
- The API client used by the gem logs in as soon as a the first method is called. The same session is used as it is valid. If you want to close the API session you can manually call the log out action :
80
+ The gem's API client authenticates as soon as the first method is called. The same session is used as it is still valid. If you want to close the API session, you can do so manually with the log out action:
81
81
 
82
82
  ```ruby
83
83
  Responsys::Api::Client.instance.logout
@@ -86,12 +86,12 @@ Responsys::Api::Client.instance.logout
86
86
  ###Notes
87
87
 
88
88
  ####Invalid email format
89
- If you try to call the API on a user that has an invalid email format, the API and the GEM will then reply with this message :
90
- ```
89
+ If you try to call the API on a user that has an invalid email address, the API and Gem will reply with this message:
90
+ ```ruby
91
91
  {
92
- :status=>"ok",
92
+ :status=>"ok",
93
93
  :result=>{
94
- :recipient_id=>"-1",
94
+ :recipient_id=>"-1",
95
95
  :error_message=>"Record 0 = BAD EMAIL FORMAT"
96
96
  }
97
97
  }
@@ -106,10 +106,7 @@ If you try to call the API on a user that has an invalid email format, the API a
106
106
  5. Create new Pull Request
107
107
 
108
108
  ## To Do
109
- * Add thorough tests with properly mocked out API responses
110
- * Build out API functionality
111
- * Member profile extension
112
- * CRUD operations (create new key/value, update value by key, delete key/value by key)
113
- * Tables
114
- * CRUD operations (create new key/value, update value by key, delete key/value by key)
115
- * Batch member profile updates
109
+ * Supplemental Tables
110
+ * CRUD operations (create new key/value, update value by key, delete key/value by key)
111
+ * Batch member profile updates
112
+ * CED SFTP File Syncing
data/responsys-api.gemspec CHANGED
@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
4
 
5
5
  Gem::Specification.new do |spec|
6
6
  spec.name = "responsys-api"
7
- spec.version = "0.0.5"
7
+ spec.version = "0.0.6"
8
8
  spec.authors = ["Dan DeMeyere", "Florian Lorrain", "Morgan Griggs", "Mike Rocco"]
9
9
  spec.email = ["dan@thredup.com", "florian.lorrain@thredup.com", "morgan@thredup.com", "michael.rocco@thredup.com"]
10
10
  spec.description = "A gem to integrate with the Responsys SOAP API"
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
18
18
  spec.require_paths = ["lib"]
19
19
 
20
20
  spec.add_dependency "rubyntlm", "~> 0.4"
21
- spec.add_dependency "savon", "~> 2.6"
21
+ spec.add_dependency "savon", "2.6.0"
22
22
  spec.add_dependency "i18n", "~> 0.6"
23
23
  spec.add_development_dependency "bundler", "~> 1.3"
24
24
  spec.add_development_dependency "rake", "~> 10.3"
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: responsys-api
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.5
4
+ version: 0.0.6
5
5
  platform: ruby
6
6
  authors:
7
7
  - Dan DeMeyere
@@ -11,7 +11,7 @@ authors:
11
11
  autorequire:
12
12
  bindir: bin
13
13
  cert_chain: []
14
- date: 2014-09-19 00:00:00.000000000 Z
14
+ date: 2014-09-26 00:00:00.000000000 Z
15
15
  dependencies:
16
16
  - !ruby/object:Gem::Dependency
17
17
  name: rubyntlm
@@ -31,16 +31,16 @@ dependencies:
31
31
  name: savon
32
32
  requirement: !ruby/object:Gem::Requirement
33
33
  requirements:
34
- - - ~>
34
+ - - '='
35
35
  - !ruby/object:Gem::Version
36
- version: '2.6'
36
+ version: 2.6.0
37
37
  type: :runtime
38
38
  prerelease: false
39
39
  version_requirements: !ruby/object:Gem::Requirement
40
40
  requirements:
41
- - - ~>
41
+ - - '='
42
42
  - !ruby/object:Gem::Version
43
- version: '2.6'
43
+ version: 2.6.0
44
44
  - !ruby/object:Gem::Dependency
45
45
  name: i18n
46
46
  requirement: !ruby/object:Gem::Requirement