freshmail_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b966404064d4d4c0171650ff3dc29ea880053742
+  data.tar.gz: b04fb438224015806d5f0567bef1bae5ed5f54ee
+SHA512:
+  metadata.gz: 91f14047d3c3176664eb943d030cf7f9483f65b8d0a0a07bf06dbcaa7d4cad9e82020a24caf9b3d6aa703e19693aba21b77b0d792b956889269f127a322eed6c
+  data.tar.gz: de5df6a31945a3e301ca467f6f94b06fb1aaac47f07d9319027b48a9e51f07a031dd2b958dd17de2e7897257471d2d601884a0adc2a6465d0ec5c29d605096ba

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Damian Śliwecki
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,368 @@
+## FreshmailApi
+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!
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'freshmail_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install freshmail_api
+
+## Usage
+
+First, you must set up config (for example in config/initializers/freshmail_api.rb) and add following code:
+
+```ruby
+FreshmailApi.configure do |config|
+  config.api_key = 'your api key'
+  config.api_secret = 'your secret key'
+end
+```
+
+Next, you should use available methods:
+
+1. Test your connection
+GET:
+```ruby
+FreshmailApi.get_ping
+```
+POST:
+```ruby
+FreshmailApi.post_ping({data: 'some data'})
+```
+
+
+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:
+:subscriber,
+:subject,
+:html or :text
+-optional options:
+:from,
+:from_name,
+:reply_to,
+:encoding,
+:attachments,
+:tracking,
+:domain,
+:tag
+
+3. Send sms message (SMS agreement required to send sms):
+```ruby
+FreshmailApi.send_sms(gsm: "123456789", text: "hello bro! :)")
+```
+-require options:
+:gsm,
+:text
+-optional options:
+:from,
+:single
+
+
+4. Reports:
+  4.1 Campaigns list
+  ```ruby
+  FreshmailApi.campaigns_list
+  or
+  FreshmailApi.campaigns_list(69)
+  ```
+  -optional options:
+  :page
+
+  4.2 Campaign report
+  ```ruby
+  FreshmailApi.campaign_report(id_hash)
+  ```
+  -required options:
+  :id_hash
+
+  4.3 Campaign time details
+  ```ruby
+  FreshmailApi.campaign_time_details(id_hash)
+  ```
+  -required options:
+  :id_hash
+
+
+5. Campaign:
+  5.1 Create:
+  ```ruby
+  FreshmailApi.create_campaign({options})
+  ```
+  -require options:
+  :name,
+  :list or :group,
+  :html or :text
+  -optional options:
+  :url,
+  :subject,
+  :from_address,
+  :from_name,
+  :reply_to,
+  :resignlink
+
+  5.1 Edit:
+  ```ruby
+  FreshmailApi.edit_campaig({options})
+  ```
+  require options:
+  :id_hash
+  optional options:
+  :name,
+  :url,
+  :html,
+  :text,
+  :subject,
+  :from_name,
+  :from_address,
+  :reply_to,
+  :list,
+  :group,
+  :resignlink
+
+  5.1 Delete:
+  ```ruby
+  FreshmailApi.delete_campaig({options})
+  ```
+  require options:
+  :hash
+
+  5.1 Send test campaign:
+  ```ruby
+  FreshmailApi.send_test_campaig(hash: '4zcnmd2ski', emails: ['test1@email.com', 'test2@email.com'])
+  ```
+  require options:
+  :hash,
+  :emails
+  optional options:
+  :custom_fields
+
+  5.1 Send campaign:
+  ```ruby
+  FreshmailApi.send_campaig({options})
+  ```
+  require options:
+  :hash
+  optional options:
+  :time (format:  YYYY-MM-DD H:i:s)
+
+
+6. Subscriber:
+  6.1 Add:
+  ```ruby
+  FreshmailApi.add_subscriber({options})
+  ```
+  -require options:
+  :email,
+  :list
+  -optional options:
+  :state,
+  :confirm,
+  :custom_fields
+
+  6.2 Edit:
+  ```ruby
+  FreshmailApi.edit_subscriber({options})
+  ```
+  -require options:
+  :email,
+  :list
+  -optional options:
+  :state,
+  :custom_fields
+
+  6.3 Add:
+  ```ruby
+  FreshmailApi.get_subscriber(email: 'test@email.com', list: '4zcnmd2ski')
+  ```
+  -require options:
+  :email,
+  :list
+
+  6.4 Delete:
+  ```ruby
+  FreshmailApi.delete_subscriber({options})
+  ```
+  -require options:
+  :email,
+  :list
+
+  6.5 History of subscriber:
+  ```ruby
+  FreshmailApi.get_subscriber_history(email: 'test@email.com', list: '4zcnmd2ski', limit: 30)
+  ```
+  -require options:
+  :email,
+  :list
+  -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:
+  :subscribers,
+  :list
+  -optional options:
+  :state,
+  :confirm
+
+  6.7 Edit subscribers:
+  ```ruby
+  FreshmailApi.edit_subscribers(subscribers: [{email: 'test@email.com'}, {email: 'test@email.com'}], list: '4zcnmd2ski')
+  ```
+  -require options:
+  :subscribers,
+  :list
+  -optional options:
+  :state,
+  :confirm
+
+  6.8 Update field value for all subscribers:
+  ```ruby
+  FreshmailApi.update_subscriber_field({options})
+  ```
+  -require options:
+  :listHash,
+  :tag,
+  :value,
+  :url
+
+  6.9 Get data from subscribers:
+  ```ruby
+  FreshmailApi.get_subscribers({options})
+  ```
+  -require options:
+  :subscribers,
+  :list
+
+  6.10 Delete subscribers:
+  ```ruby
+  FreshmailApi.delete_subscribers({options})
+  ```
+  -require options:
+  :subscribers,
+  :list
+
+  6.11 Block subscribers:
+  ```ruby
+  FreshmailApi.block_subscribers({options})
+  ```
+  -require options:
+  :emails
+
+  6.12 Unblock subscribers:
+  ```ruby
+  FreshmailApi.unblock_subscribers({options})
+  ```
+  -require options:
+  :emails
+
+
+7. Create account:
+```ruby
+FreshmailApi.create_account({options})
+```
+-require options:
+:login,
+:password,
+:firstname,
+:lastname,
+:phone
+-optional options:
+:company,
+:activation_email,
+:activation,
+:child_account
+
+
+8. Subscribers list:
+  8.1 Create:
+  ```ruby
+  FreshmailApi.create_subscribers_list({options})
+  ```
+  -require options:
+  :name
+  -optional options:
+  :description,
+  :custom_field
+
+  8.2 Update:
+  ```ruby
+  FreshmailApi.update_subscribers_list({options})
+  ```
+  -require options:
+  :hash,
+  :name
+  -optional options:
+  :description
+
+  8.3 Delete:
+  ```ruby
+  FreshmailApi.delete_subscribers_list({options})
+  ```
+  -require options:
+  :hash
+
+  8.4 Get lists:
+  ```ruby
+  FreshmailApi.get_subscribers_lists
+  ```
+
+  8.5 Add extra field:
+  ```ruby
+  FreshmailApi.add_field_to_subscribers_list({options})
+  ```
+  -require options:
+  :hash,
+  :name
+  -optional options:
+  :tag,
+  :type
+
+  8.6 Get extra fields:
+  ```ruby
+  FreshmailApi.get_subscribers_list_fields({options})
+  ```
+  -require options:
+  :hash
+
+9. Spam test:
+```ruby
+FreshmailApi.check_spam_test({options})
+```
+-require options:
+:subject
+-optional options:
+:from,
+:from_name,
+:html or :text
+
+
+## Contributing
+
+1. Fork it ( https://github.com/sliwecki/freshmail_api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/freshmail_api.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'freshmail_api/version'
+
+Gem::Specification.new do |spec|
+  spec.version       = FreshmailApi::VERSION
+  spec.name          = "freshmail_api"
+  spec.authors       = ["Damian Śliwecki"]
+  spec.email         = ["sliwecki@gmail.com"]
+  spec.summary       = %q{Freshmail REST API v3.0}
+  spec.description   = %q{Rails gem for fast Freshmail integration}
+  spec.homepage      = "https://github.com/sliwecki"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.9.1"
+  spec.add_dependency "json"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/freshmail_api/account.rb

@@ -0,0 +1,8 @@
+module FreshmailApi
+  module Account
+
+    def create_account(data)
+      perform(:post, 'account/create', data)
+    end
+  end
+end

data/lib/freshmail_api/authorization.rb

@@ -0,0 +1,13 @@
+module FreshmailApi
+  module Authorization
+
+    def authorize(path, data)
+      Digest::SHA1.hexdigest([
+        configuration.api_key,
+        path,
+        data,
+        configuration.api_secret
+      ].join)
+    end
+  end
+end

data/lib/freshmail_api/campaign.rb

@@ -0,0 +1,24 @@
+module FreshmailApi
+  module Campaign
+
+    def create_campaign(data)
+      perform(:post, 'campaigns/create', data)
+    end
+
+    def edit_campaig(data)
+      perform(:post, 'campaigns/edit', data)
+    end
+
+    def delete_campaig(data)
+      perform(:post, 'campaigns/delete', data)
+    end
+
+    def send_test_campaig(data)
+      perform(:post, 'campaigns/sendTest', data)
+    end
+
+    def send_campaig(data)
+      perform(:post, 'campaigns/send', data)
+    end
+  end
+end

data/lib/freshmail_api/client.rb

@@ -0,0 +1,35 @@
+module FreshmailApi
+  module Client
+
+    ENDPOINT = 'https://api.freshmail.com'
+
+    def perform(method, path, data={})
+      data = parse_data(data)
+      path = "/rest/#{path}"
+      response = client.send(method, path) do |request|
+        request.headers = headers(path, data)
+        request.body    = data if method == :post
+      end
+
+      JSON.parse(response.body)
+    end
+
+    private
+
+    def client
+      @client ||= Faraday.new(ENDPOINT)
+    end
+
+    def parse_data(data)
+      data.empty? ? '' : data.to_json
+    end
+
+    def headers(path, data)
+      {
+        'Content-Type'   => 'application/json',
+        'X-Rest-ApiKey'  => configuration.api_key,
+        'X-Rest-ApiSign' => authorize(path, data)
+      }
+    end
+  end
+end

data/lib/freshmail_api/configuration.rb

@@ -0,0 +1,6 @@
+module FreshmailApi
+  class Configuration
+
+    attr_accessor :api_key, :api_secret
+  end
+end

data/lib/freshmail_api/mail.rb

@@ -0,0 +1,8 @@
+module FreshmailApi
+  module Mail
+
+    def send_mail(data)
+      perform(:post, 'mail', data)
+    end
+  end
+end

data/lib/freshmail_api/ping.rb

@@ -0,0 +1,12 @@
+module FreshmailApi
+  module Ping
+
+    def get_ping
+      perform(:get, 'ping')
+    end
+
+    def post_ping(data)
+      perform(:post, 'ping', data)
+    end
+  end
+end

data/lib/freshmail_api/report.rb

@@ -0,0 +1,16 @@
+module FreshmailApi
+  module Report
+
+    def campaigns_list(page='')
+      perform(:get, "reports/campaignsList/#{page}")
+    end
+
+    def campaign_report(id_hash)
+      perform(:get, "reports/campaign/#{id_hash}")
+    end
+
+    def campaign_time_details(id_hash)
+      perform(:get, "reports/campaignTimeDetails/#{id_hash}")
+    end
+  end
+end

data/lib/freshmail_api/sms.rb

@@ -0,0 +1,8 @@
+module FreshmailApi
+  module Sms
+
+    def send_sms(data)
+      perform(:post, 'sms', data)
+    end
+  end
+end

data/lib/freshmail_api/spam_test.rb

@@ -0,0 +1,8 @@
+module FreshmailApi
+  module SpamTest
+
+    def check_spam_test(data)
+      perform(:post, 'spam_test/check', data)
+    end
+  end
+end

data/lib/freshmail_api/subscriber.rb

@@ -0,0 +1,52 @@
+module FreshmailApi
+  module Subscriber
+
+    def add_subscriber(data)
+      perform(:post, 'subscriber/add', data)
+    end
+
+    def edit_subscriber(data)
+      perform(:post, 'subscriber/edit', data)
+    end
+
+    def get_subscriber(data)
+      perform(:get, "subscriber/get/#{data[:list]}/#{data[:email]}")
+    end
+
+    def delete_subscriber(data)
+      perform(:post, 'subscriber/delete', data)
+    end
+
+    def get_subscriber_history(data)
+      perform(:post, 'subscriber/getHistory', data)
+    end
+
+    def add_subscribers(data)
+      perform(:post, 'subscriber/addMultiple', data)
+    end
+
+    def edit_subscribers(data)
+      perform(:post, 'subscriber/editMultiple', data)
+    end
+
+    def update_subscriber_field(data)
+      perform(:post, 'subscriber/updateFieldValue', data)
+    end
+
+    def get_subscribers(data)
+      perform(:post, "subscriber/getMultiple", data)
+    end
+
+    def delete_subscribers(data)
+      perform(:post, "subscriber/deleteMultiple", data)
+    end
+
+    def block_subscribers(data)
+      perform(:post, "subscriber/addBlocks", data)
+    end
+
+    def unblock_subscribers(data)
+      perform(:post, "subscriber/removeBlocks", data)
+    end
+  end
+end

data/lib/freshmail_api/subscribers_list.rb

@@ -0,0 +1,28 @@
+module FreshmailApi
+  module SubscribersList
+
+    def create_subscribers_list(data)
+      perform(:post, "subscribers_list/create", data)
+    end
+
+    def update_subscribers_list(data)
+      perform(:post, "subscribers_list/update", data)
+    end
+
+    def delete_subscribers_list(data)
+      perform(:post, "subscribers_list/delete", data)
+    end
+
+    def get_subscribers_lists
+      perform(:get, "subscribers_list/lists")
+    end
+
+    def add_field_to_subscribers_list(data)
+      perform(:post, "subscribers_list/addField", data)
+    end
+
+    def get_subscribers_list_fields(data)
+      perform(:post, "subscribers_list/getFields", data)
+    end
+  end
+end

data/lib/freshmail_api/version.rb

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

data/lib/freshmail_api.rb

@@ -0,0 +1,40 @@
+require 'faraday'
+require 'json'
+require 'freshmail_api/version'
+require 'freshmail_api/configuration'
+require 'freshmail_api/authorization'
+require 'freshmail_api/client'
+require 'freshmail_api/ping'
+require 'freshmail_api/mail'
+require 'freshmail_api/sms'
+require 'freshmail_api/account'
+require 'freshmail_api/spam_test'
+require 'freshmail_api/report'
+require 'freshmail_api/campaign'
+require 'freshmail_api/subscriber'
+require 'freshmail_api/subscribers_list'
+
+module FreshmailApi
+  extend Authorization
+  extend Client
+  extend Ping
+  extend Mail
+  extend Sms
+  extend Subscriber
+  extend Account
+  extend SpamTest
+  extend Report
+  extend Campaign
+  extend SubscribersList
+
+  class << self
+
+    def configure
+      yield(configuration) if block_given?
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+end

data/spec/freshmail_api_spec.rb

@@ -0,0 +1,292 @@
+require 'spec_helper'
+
+describe FreshmailApi do
+  let(:url) { "https://api.freshmail.com/rest/#{path}" }
+  let(:stubs) { Faraday::Adapter::Test::Stubs.new }
+  let(:client) { Faraday.new { |builder| builder.adapter(:test, stubs) }}
+
+  before do
+    allow(described_class).to receive(:client) { client }
+
+    described_class.configure do |config|
+      config.api_key    = 'api_key_1'
+      config.api_secret = 'api_secret_1'
+    end
+  end
+
+  describe '.configuration' do
+    it 'not be nil' do
+      expect(described_class.configuration.api_key).not_to be(nil)
+      expect(described_class.configuration.api_secret).not_to be(nil)
+    end
+
+    it 'api_key should eq api_key_1' do
+      expect(described_class.configuration.api_key).to eq('api_key_1')
+    end
+
+    it 'api_secret should eq api_secret_1' do
+      expect(described_class.configuration.api_secret).to eq('api_secret_1')
+    end
+  end
+
+  context 'Ping' do
+    let(:path) { 'ping' }
+    it '.get_ping' do
+      stubs.get(url) { |env| [ 200, {}, '{"status": "get_ping OK"}']}
+      expect(described_class.get_ping).to eq({ 'status' => 'get_ping OK' })
+    end
+
+    it '.post_ping' do
+      stubs.post(url) { |env| [ 200, {}, '{"status": "post_ping OK"}']}
+      expect(described_class.post_ping({data: 'data'})).to eq({ 'status' => 'post_ping OK' })
+    end
+  end
+
+  context 'Account' do
+    let(:path) { 'account/create' }
+    it '.create_account' do
+      stubs.post(url) { |env| [ 200, {}, '{"status": "create_account OK"}']}
+      expect(described_class.create_account({data: 'data'})).to eq({ 'status' => 'create_account OK' })
+    end
+  end
+
+  context 'Mail' do
+    let(:path) { 'mail' }
+    it '.send_mail' do
+      stubs.post(url) { |env| [ 200, {}, '{"status": "send_mail OK"}']}
+      expect(described_class.send_mail({data: 'data'})).to eq({ 'status' => 'send_mail OK' })
+    end
+  end
+
+  context 'Sms' do
+    let(:path) { 'sms' }
+    it '.send_sms' do
+      stubs.post(url) { |env| [ 200, {}, '{"status": "send_sms OK"}']}
+      expect(described_class.send_sms({data: 'data'})).to eq({ 'status' => 'send_sms OK' })
+    end
+  end
+
+  context 'SpanTest' do
+    let(:path) { 'spam_test/check' }
+    it '.check_spam_test' do
+      stubs.post(url) { |env| [ 200, {}, '{"status": "check_spam_test OK"}']}
+      expect(described_class.check_spam_test({data: 'data'})).to eq({ 'status' => 'check_spam_test OK' })
+    end
+  end
+
+  context 'Report' do
+    describe '.campaigns_list' do
+      let(:path) { 'reports/campaignsList/1' }
+      it do
+        stubs.get(url) { |env| [ 200, {}, '{"status": "campaigns_list OK"}']}
+        expect(described_class.campaigns_list(1)).to eq({ 'status' => 'campaigns_list OK' })
+      end
+    end
+
+    describe '.campaign_report' do
+      let(:path) { 'reports/campaign/1' }
+      it do
+        stubs.get(url) { |env| [ 200, {}, '{"status": "campaign_report OK"}']}
+        expect(described_class.campaign_report(1)).to eq({ 'status' => 'campaign_report OK' })
+      end
+    end
+
+    describe '.campaign_time_details' do
+      let(:path) { 'reports/campaignTimeDetails/1' }
+      it do
+        stubs.get(url) { |env| [ 200, {}, '{"status": "campaign_time_details OK"}']}
+        expect(described_class.campaign_time_details(1)).to eq({ 'status' => 'campaign_time_details OK' })
+      end
+    end
+  end
+
+  context 'Campaign' do
+    describe '.create_campaign' do
+      let(:path) { 'campaigns/create' }
+      it do
+        stubs.post(url) { |env| [ 200, {}, '{"status": "create_campaign OK"}']}
+        expect(described_class.create_campaign({data: 'data'})).to eq({ 'status' => 'create_campaign OK' })
+      end
+    end
+
+    describe '.edit_campaig' 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' })
+      end
+    end
+
+    describe '.delete_campaig' 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' })
+      end
+    end
+
+    describe '.send_test_campaig' 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' })
+      end
+    end
+
+    describe '.send_campaig' 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' })
+      end
+    end
+  end
+
+  context 'SubscribersList' do
+    describe '.create_subscribers_list' do
+      let(:path) { 'subscribers_list/create' }
+      it do
+        stubs.post(url) { |env| [ 200, {}, '{"status": "create_subscribers_list OK"}']}
+        expect(described_class.create_subscribers_list({data: 'data'})).to eq({ 'status' => 'create_subscribers_list OK' })
+      end
+    end
+
+    describe '.update_subscribers_list' do
+      let(:path) { 'subscribers_list/update' }
+      it do
+        stubs.post(url) { |env| [ 200, {}, '{"status": "update_subscribers_list OK"}']}
+        expect(described_class.update_subscribers_list({data: 'data'})).to eq({ 'status' => 'update_subscribers_list OK' })
+      end
+    end
+
+    describe '.delete_subscribers_list' do
+      let(:path) { 'subscribers_list/delete' }
+      it do
+        stubs.post(url) { |env| [ 200, {}, '{"status": "delete_subscribers_list OK"}']}
+        expect(described_class.delete_subscribers_list({data: 'data'})).to eq({ 'status' => 'delete_subscribers_list OK' })
+      end
+    end
+
+    describe '.get_subscribers_lists' do
+      let(:path) { 'subscribers_list/lists' }
+      it do
+        stubs.get(url) { |env| [ 200, {}, '{"status": "get_subscribers_lists OK"}']}
+        expect(described_class.get_subscribers_lists).to eq({ 'status' => 'get_subscribers_lists OK' })
+      end
+    end
+
+    describe '.add_field_to_subscribers_list' do
+      let(:path) { 'subscribers_list/addField' }
+      it do
+        stubs.post(url) { |env| [ 200, {}, '{"status": "add_field_to_subscribers_list OK"}']}
+        expect(described_class.add_field_to_subscribers_list({data: 'data'})).to eq({ 'status' => 'add_field_to_subscribers_list OK' })
+      end
+    end
+
+    describe '.get_subscribers_list_fields' do
+      let(:path) { 'subscribers_list/getFields' }
+      it do
+        stubs.post(url) { |env| [ 200, {}, '{"status": "get_subscribers_list_fields OK"}']}
+        expect(described_class.get_subscribers_list_fields({data: 'data'})).to eq({ 'status' => 'get_subscribers_list_fields OK' })
+      end
+    end
+  end
+
+  context 'Subscriber' do
+    describe '.add_subscriber' do
+      let(:path) { 'subscriber/add' }
+      it do
+        stubs.post(url) { |env| [ 200, {}, '{"status": "add_subscriber OK"}']}
+        expect(described_class.add_subscriber({data: 'data'})).to eq({ 'status' => 'add_subscriber OK' })
+      end
+    end
+
+    describe '.edit_subscriber' do
+      let(:path) { 'subscriber/edit' }
+      it do
+        stubs.post(url) { |env| [ 200, {}, '{"status": "edit_subscriber OK"}']}
+        expect(described_class.edit_subscriber({data: 'data'})).to eq({ 'status' => 'edit_subscriber OK' })
+      end
+    end
+
+    describe '.get_subscriber' do
+      let(:path) { 'subscriber/get/1/some@mail.com' }
+      it do
+        stubs.get(url) { |env| [ 200, {}, '{"status": "get_subscriber OK"}']}
+        expect(described_class.get_subscriber({list: 1, email: 'some@mail.com'})).to eq({ 'status' => 'get_subscriber OK' })
+      end
+    end
+
+    describe '.delete_subscriber' do
+      let(:path) { 'subscriber/delete' }
+      it do
+        stubs.post(url) { |env| [ 200, {}, '{"status": "delete_subscriber OK"}']}
+        expect(described_class.delete_subscriber({data: 'data'})).to eq({ 'status' => 'delete_subscriber OK' })
+      end
+    end
+
+    describe '.get_subscriber_history' do
+      let(:path) { 'subscriber/getHistory' }
+      it do
+        stubs.post(url) { |env| [ 200, {}, '{"status": "get_subscriber_history OK"}']}
+        expect(described_class.get_subscriber_history({data: 'data'})).to eq({ 'status' => 'get_subscriber_history OK' })
+      end
+    end
+
+    describe '.add_subscribers' do
+      let(:path) { 'subscriber/addMultiple' }
+      it do
+        stubs.post(url) { |env| [ 200, {}, '{"status": "add_subscribers OK"}']}
+        expect(described_class.add_subscribers({data: 'data'})).to eq({ 'status' => 'add_subscribers OK' })
+      end
+    end
+
+    describe '.edit_subscribers' do
+      let(:path) { 'subscriber/editMultiple' }
+      it do
+        stubs.post(url) { |env| [ 200, {}, '{"status": "edit_subscribers OK"}']}
+        expect(described_class.edit_subscribers({data: 'data'})).to eq({ 'status' => 'edit_subscribers OK' })
+      end
+    end
+
+    describe '.update_subscriber_field' do
+      let(:path) { 'subscriber/updateFieldValue' }
+      it do
+        stubs.post(url) { |env| [ 200, {}, '{"status": "update_subscriber_field OK"}']}
+        expect(described_class.update_subscriber_field({data: 'data'})).to eq({ 'status' => 'update_subscriber_field OK' })
+      end
+    end
+
+    describe '.get_subscribers' do
+      let(:path) { 'subscriber/getMultiple' }
+      it do
+        stubs.post(url) { |env| [ 200, {}, '{"status": "get_subscribers OK"}']}
+        expect(described_class.get_subscribers({data: 'data'})).to eq({ 'status' => 'get_subscribers OK' })
+      end
+    end
+
+    describe '.delete_subscribers' do
+      let(:path) { 'subscriber/deleteMultiple' }
+      it do
+        stubs.post(url) { |env| [ 200, {}, '{"status": "delete_subscribers OK"}']}
+        expect(described_class.delete_subscribers({data: 'data'})).to eq({ 'status' => 'delete_subscribers OK' })
+      end
+    end
+
+    describe '.block_subscribers' do
+      let(:path) { 'subscriber/addBlocks' }
+      it do
+        stubs.post(url) { |env| [ 200, {}, '{"status": "block_subscribers OK"}']}
+        expect(described_class.block_subscribers({data: 'data'})).to eq({ 'status' => 'block_subscribers OK' })
+      end
+    end
+
+    describe '.unblock_subscribers' do
+      let(:path) { 'subscriber/removeBlocks' }
+      it do
+        stubs.post(url) { |env| [ 200, {}, '{"status": "unblock_subscribers OK"}']}
+        expect(described_class.unblock_subscribers({data: 'data'})).to eq({ 'status' => 'unblock_subscribers OK' })
+      end
+    end
+  end
+end

data/spec/lib/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe FreshmailApi::VERSION do
+  it 'has a version number' do
+    expect(FreshmailApi::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'freshmail_api'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: freshmail_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Damian Śliwecki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-06 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
+email:
+- sliwecki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- freshmail_api.gemspec
+- lib/freshmail_api.rb
+- lib/freshmail_api/account.rb
+- lib/freshmail_api/authorization.rb
+- lib/freshmail_api/campaign.rb
+- lib/freshmail_api/client.rb
+- lib/freshmail_api/configuration.rb
+- lib/freshmail_api/mail.rb
+- lib/freshmail_api/ping.rb
+- lib/freshmail_api/report.rb
+- lib/freshmail_api/sms.rb
+- lib/freshmail_api/spam_test.rb
+- lib/freshmail_api/subscriber.rb
+- lib/freshmail_api/subscribers_list.rb
+- lib/freshmail_api/version.rb
+- spec/freshmail_api_spec.rb
+- spec/lib/version_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sliwecki
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Freshmail REST API v3.0
+test_files:
+- spec/freshmail_api_spec.rb
+- spec/lib/version_spec.rb
+- spec/spec_helper.rb