freshmail_api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b966404064d4d4c0171650ff3dc29ea880053742
-  data.tar.gz: b04fb438224015806d5f0567bef1bae5ed5f54ee
+  metadata.gz: 80b8413d996326483acce67780fb2379c598455d
+  data.tar.gz: 2e935ed9974303f795b6a23d00588045678c3203
 SHA512:
-  metadata.gz: 91f14047d3c3176664eb943d030cf7f9483f65b8d0a0a07bf06dbcaa7d4cad9e82020a24caf9b3d6aa703e19693aba21b77b0d792b956889269f127a322eed6c
-  data.tar.gz: de5df6a31945a3e301ca467f6f94b06fb1aaac47f07d9319027b48a9e51f07a031dd2b958dd17de2e7897257471d2d601884a0adc2a6465d0ec5c29d605096ba
+  metadata.gz: b8a647e1f4927dff45f1957661ccc3d4b0aef51400c13e77bbdcf98a8e5939c721ea00ad45ec5748e889d26f976685fec1c6cfbe20d7108fd0a578d9b95c9d5a
+  data.tar.gz: 064db7c7b0fe6749a37563db32461c7ff0b1917cff8bd3be9031325ea34eece41a7d228d3174888d9f0cbb7e3109e6d74592edbe963597968c45cf14c3f14032

data/README.md

@@ -3,7 +3,7 @@ Rails gem for fast Freshmail integration
 
 Documentation of Freshmail API http://freshmail.pl/wp-content/uploads/2013/04/REST_API_v1.0.19.pdf
 
-## Do you like it? Give me star ;) Thank you!
+##### Do you like it ? Give me star ;) Thank you!
 
 
 ## Installation
@@ -35,28 +35,29 @@ end
 
 Next, you should use available methods:
 
-1. Test your connection
+##### 1) Test your connection
+
 GET:
 ```ruby
 FreshmailApi.get_ping
 ```
+
 POST:
 ```ruby
 FreshmailApi.post_ping({data: 'some data'})
 ```
 
-
-2. Send mail:
+##### 2) Send mail:
 ```ruby
 FreshmailApi.send_mail(subscriber: "subscriber@mail.com", subject: "test", text: "pure text message")
 or
 FreshmailApi.send_mail(subscriber: "subscriber@mail.com", subject: "test", html: "message with html tags")
 ```
--require options:
+>- require options:
 :subscriber,
 :subject,
 :html or :text
--optional options:
+>- optional options:
 :from,
 :from_name,
 :reply_to,
@@ -66,53 +67,53 @@ FreshmailApi.send_mail(subscriber: "subscriber@mail.com", subject: "test", html:
 :domain,
 :tag
 
-3. Send sms message (SMS agreement required to send sms):
+##### 3) Send sms message (SMS agreement required to send sms):
 ```ruby
 FreshmailApi.send_sms(gsm: "123456789", text: "hello bro! :)")
 ```
--require options:
+>- require options:
 :gsm,
 :text
--optional options:
+>- optional options:
 :from,
 :single
 
 
-4. Reports:
+##### 4) Reports:
   4.1 Campaigns list
   ```ruby
   FreshmailApi.campaigns_list
   or
   FreshmailApi.campaigns_list(69)
   ```
-  -optional options:
+  >- optional options:
   :page
 
   4.2 Campaign report
   ```ruby
   FreshmailApi.campaign_report(id_hash)
   ```
-  -required options:
+  >- required options:
   :id_hash
 
   4.3 Campaign time details
   ```ruby
   FreshmailApi.campaign_time_details(id_hash)
   ```
-  -required options:
+  >- required options:
   :id_hash
 
 
-5. Campaign:
+##### 5) Campaign:
   5.1 Create:
   ```ruby
   FreshmailApi.create_campaign({options})
   ```
-  -require options:
+  >- require options:
   :name,
   :list or :group,
   :html or :text
-  -optional options:
+  >- optional options:
   :url,
   :subject,
   :from_address,
@@ -122,11 +123,11 @@ FreshmailApi.send_sms(gsm: "123456789", text: "hello bro! :)")
 
   5.1 Edit:
   ```ruby
-  FreshmailApi.edit_campaig({options})
+  FreshmailApi.edit_campaign({options})
   ```
-  require options:
+  >- require options:
   :id_hash
-  optional options:
+  >- optional options:
   :name,
   :url,
   :html,
@@ -141,40 +142,40 @@ FreshmailApi.send_sms(gsm: "123456789", text: "hello bro! :)")
 
   5.1 Delete:
   ```ruby
-  FreshmailApi.delete_campaig({options})
+  FreshmailApi.delete_campaign({options})
   ```
-  require options:
+  >- require options:
   :hash
 
   5.1 Send test campaign:
   ```ruby
-  FreshmailApi.send_test_campaig(hash: '4zcnmd2ski', emails: ['test1@email.com', 'test2@email.com'])
+  FreshmailApi.send_test_campaign(hash: '4zcnmd2ski', emails: ['test1@email.com', 'test2@email.com'])
   ```
-  require options:
+  >- require options:
   :hash,
   :emails
-  optional options:
+  >- optional options:
   :custom_fields
 
   5.1 Send campaign:
   ```ruby
-  FreshmailApi.send_campaig({options})
+  FreshmailApi.send_campaign({options})
   ```
-  require options:
+  >- require options:
   :hash
-  optional options:
+  >- optional options:
   :time (format:  YYYY-MM-DD H:i:s)
 
 
-6. Subscriber:
+##### 6) Subscriber:
   6.1 Add:
   ```ruby
   FreshmailApi.add_subscriber({options})
   ```
-  -require options:
+  >- require options:
   :email,
   :list
-  -optional options:
+  >- optional options:
   :state,
   :confirm,
   :custom_fields
@@ -183,18 +184,18 @@ FreshmailApi.send_sms(gsm: "123456789", text: "hello bro! :)")
   ```ruby
   FreshmailApi.edit_subscriber({options})
   ```
-  -require options:
+  >- require options:
   :email,
   :list
-  -optional options:
+  >- optional options:
   :state,
   :custom_fields
 
-  6.3 Add:
+  6.3 Get:
   ```ruby
   FreshmailApi.get_subscriber(email: 'test@email.com', list: '4zcnmd2ski')
   ```
-  -require options:
+  >- require options:
   :email,
   :list
 
@@ -202,7 +203,7 @@ FreshmailApi.send_sms(gsm: "123456789", text: "hello bro! :)")
   ```ruby
   FreshmailApi.delete_subscriber({options})
   ```
-  -require options:
+  >- require options:
   :email,
   :list
 
@@ -210,20 +211,20 @@ FreshmailApi.send_sms(gsm: "123456789", text: "hello bro! :)")
   ```ruby
   FreshmailApi.get_subscriber_history(email: 'test@email.com', list: '4zcnmd2ski', limit: 30)
   ```
-  -require options:
+  >- require options:
   :email,
   :list
-  -optional options:
+  >- optional options:
   :limit (default: 10)
 
   6.6 Add subscribers:
   ```ruby
   FreshmailApi.add_subscribers(subscribers: [{email: 'test@email.com'}, {email: 'test@email.com'}], list: '4zcnmd2ski')
   ```
-  -require options:
+  >- require options:
   :subscribers,
   :list
-  -optional options:
+  >- optional options:
   :state,
   :confirm
 
@@ -231,10 +232,10 @@ FreshmailApi.send_sms(gsm: "123456789", text: "hello bro! :)")
   ```ruby
   FreshmailApi.edit_subscribers(subscribers: [{email: 'test@email.com'}, {email: 'test@email.com'}], list: '4zcnmd2ski')
   ```
-  -require options:
+  >- require options:
   :subscribers,
   :list
-  -optional options:
+  >- optional options:
   :state,
   :confirm
 
@@ -242,7 +243,7 @@ FreshmailApi.send_sms(gsm: "123456789", text: "hello bro! :)")
   ```ruby
   FreshmailApi.update_subscriber_field({options})
   ```
-  -require options:
+  >- require options:
   :listHash,
   :tag,
   :value,
@@ -252,7 +253,7 @@ FreshmailApi.send_sms(gsm: "123456789", text: "hello bro! :)")
   ```ruby
   FreshmailApi.get_subscribers({options})
   ```
-  -require options:
+  >- require options:
   :subscribers,
   :list
 
@@ -260,7 +261,7 @@ FreshmailApi.send_sms(gsm: "123456789", text: "hello bro! :)")
   ```ruby
   FreshmailApi.delete_subscribers({options})
   ```
-  -require options:
+  >- require options:
   :subscribers,
   :list
 
@@ -268,42 +269,42 @@ FreshmailApi.send_sms(gsm: "123456789", text: "hello bro! :)")
   ```ruby
   FreshmailApi.block_subscribers({options})
   ```
-  -require options:
+  >- require options:
   :emails
 
   6.12 Unblock subscribers:
   ```ruby
   FreshmailApi.unblock_subscribers({options})
   ```
-  -require options:
+  >- require options:
   :emails
 
 
-7. Create account:
+##### 7) Create account:
 ```ruby
 FreshmailApi.create_account({options})
 ```
--require options:
+>- require options:
 :login,
 :password,
 :firstname,
 :lastname,
 :phone
--optional options:
+>- optional options:
 :company,
 :activation_email,
 :activation,
 :child_account
 
 
-8. Subscribers list:
+##### 8) Subscribers list:
   8.1 Create:
   ```ruby
   FreshmailApi.create_subscribers_list({options})
   ```
-  -require options:
+  >- require options:
   :name
-  -optional options:
+  >- optional options:
   :description,
   :custom_field
 
@@ -311,17 +312,17 @@ FreshmailApi.create_account({options})
   ```ruby
   FreshmailApi.update_subscribers_list({options})
   ```
-  -require options:
+  >- require options:
   :hash,
   :name
-  -optional options:
+  >- optional options:
   :description
 
   8.3 Delete:
   ```ruby
   FreshmailApi.delete_subscribers_list({options})
   ```
-  -require options:
+  >- require options:
   :hash
 
   8.4 Get lists:
@@ -333,10 +334,10 @@ FreshmailApi.create_account({options})
   ```ruby
   FreshmailApi.add_field_to_subscribers_list({options})
   ```
-  -require options:
+  >- require options:
   :hash,
   :name
-  -optional options:
+  >- optional options:
   :tag,
   :type
 
@@ -344,16 +345,16 @@ FreshmailApi.create_account({options})
   ```ruby
   FreshmailApi.get_subscribers_list_fields({options})
   ```
-  -require options:
+  >- require options:
   :hash
 
-9. Spam test:
+##### 9) Spam test:
 ```ruby
 FreshmailApi.check_spam_test({options})
 ```
--require options:
+>- require options:
 :subject
--optional options:
+>- optional options:
 :from,
 :from_name,
 :html or :text

data/lib/freshmail_api/campaign.rb

@@ -5,19 +5,19 @@ module FreshmailApi
       perform(:post, 'campaigns/create', data)
     end
 
-    def edit_campaig(data)
+    def edit_campaign(data)
       perform(:post, 'campaigns/edit', data)
     end
 
-    def delete_campaig(data)
+    def delete_campaign(data)
       perform(:post, 'campaigns/delete', data)
     end
 
-    def send_test_campaig(data)
+    def send_test_campaign(data)
       perform(:post, 'campaigns/sendTest', data)
     end
 
-    def send_campaig(data)
+    def send_campaign(data)
       perform(:post, 'campaigns/send', data)
     end
   end

data/lib/freshmail_api/version.rb

@@ -1,3 +1,3 @@
 module FreshmailApi
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/freshmail_api_spec.rb

@@ -109,35 +109,35 @@ describe FreshmailApi do
       end
     end
 
-    describe '.edit_campaig' do
+    describe '.edit_campaign' do
       let(:path) { 'campaigns/edit' }
       it do
-        stubs.post(url) { |env| [ 200, {}, '{"status": "edit_campaig OK"}']}
-        expect(described_class.edit_campaig({data: 'data'})).to eq({ 'status' => 'edit_campaig OK' })
+        stubs.post(url) { |env| [ 200, {}, '{"status": "edit_campaign OK"}']}
+        expect(described_class.edit_campaign({data: 'data'})).to eq({ 'status' => 'edit_campaign OK' })
       end
     end
 
-    describe '.delete_campaig' do
+    describe '.delete_campaign' do
       let(:path) { 'campaigns/delete' }
       it do
-        stubs.post(url) { |env| [ 200, {}, '{"status": "delete_campaig OK"}']}
-        expect(described_class.delete_campaig({data: 'data'})).to eq({ 'status' => 'delete_campaig OK' })
+        stubs.post(url) { |env| [ 200, {}, '{"status": "delete_campaign OK"}']}
+        expect(described_class.delete_campaign({data: 'data'})).to eq({ 'status' => 'delete_campaign OK' })
       end
     end
 
-    describe '.send_test_campaig' do
+    describe '.send_test_campaign' do
       let(:path) { 'campaigns/sendTest' }
       it do
-        stubs.post(url) { |env| [ 200, {}, '{"status": "send_test_campaig OK"}']}
-        expect(described_class.send_test_campaig({data: 'data'})).to eq({ 'status' => 'send_test_campaig OK' })
+        stubs.post(url) { |env| [ 200, {}, '{"status": "send_test_campaign OK"}']}
+        expect(described_class.send_test_campaign({data: 'data'})).to eq({ 'status' => 'send_test_campaign OK' })
       end
     end
 
-    describe '.send_campaig' do
+    describe '.send_campaign' do
       let(:path) { 'campaigns/send' }
       it do
-        stubs.post(url) { |env| [ 200, {}, '{"status": "send_campaig OK"}']}
-        expect(described_class.send_campaig({data: 'data'})).to eq({ 'status' => 'send_campaig OK' })
+        stubs.post(url) { |env| [ 200, {}, '{"status": "send_campaign OK"}']}
+        expect(described_class.send_campaign({data: 'data'})).to eq({ 'status' => 'send_campaign OK' })
       end
     end
   end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: freshmail_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Damian Śliwecki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-06 00:00:00.000000000 Z
+date: 2015-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: json
   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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Rails gem for fast Freshmail integration
@@ -87,9 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -122,17 +122,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Freshmail REST API v3.0