smtpcom_api 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem "faraday_middleware"
+
+group :development do
+  gem "rdoc", "~> 3.12"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "simplecov"
+  gem "rspec", "~> 2.8.0"
+  gem "rspec-mocks"
+  gem "webmock"
+  gem "vcr"
+end

data/Gemfile.lock

@@ -0,0 +1,52 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.8)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    faraday (0.8.1)
+      multipart-post (~> 1.1)
+    faraday_middleware (0.8.7)
+      faraday (>= 0.7.4, < 0.9)
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    multi_json (1.3.6)
+    multipart-post (1.1.5)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    vcr (2.2.0)
+    webmock (1.8.7)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  faraday_middleware
+  jeweler (~> 1.8.3)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  rspec-mocks
+  simplecov
+  vcr
+  webmock

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Vasiliy Sablin
+
+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,110 @@
+# SmtpcomApi
+
+SmtpcomApi is a ruby wrapper for the http://smtp.com API (http://api.smtp.com)
+
+## Installation
+    [sudo] gem install smtpcom_api
+
+## Usage
+
+### Authentication
+
+You need api key and api url for authentication in SmtpcomApi
+
+    client = SmtpcomApi::Client.new('your_api_key', 'api_url')
+
+### Account settings
+
+Getting account
+
+    account = client.account
+
+Getting account attributes as hash
+
+    account.attributes 
+    # or
+    account.to_hash
+
+Updating account attributes:
+
+    account.company_name = 'My Company'
+    account.save
+
+### Senders
+
+Getting senders list
+
+    senders = client.senders 
+    # or 
+    senders = account.senders
+
+Finding one sender by his label or id
+
+    sender = client.sender('sender_label_or_id') 
+    # or
+    sender = account.sender('sender_label_or_id')
+
+Getting sender attributes as hash
+
+    sener.attributes
+    # or 
+    sender.to_hash
+
+Updating sender attributes 
+
+    sender.login    = 'new_login'
+    sender.password = 'new_password1'
+    sender.save
+
+Adding new sender
+
+    attributes = { 
+      :label      => 'my_label', 
+      :login      => 'my_login', 
+      :password   => 'my_password1',
+      :max_quota  => 10000
+    }
+    new_sender = client.add_sender attributes
+
+Some senders could be authenticated by IP address instead of login/pass
+To allow sender login that way you should set :is_ip_based attribute to true and add allowed IPs
+
+    # setting is_ip_based = true
+    new_sender.is_ip_based = true
+    new_sender.save
+    
+    # adding allowed IPs
+    new_sender.add_allowed_ip('222.178.23.97')
+
+    # or removing some
+    new_sender.remove_allowed_ip('222.178.23.97')
+
+### Statistics
+
+Examples how to get sender statistics data (summary/detailed delivery/campaigns/complaints/queue):
+
+    now       = Time.now.to_i
+    month_ago = now - 30*24*60*60
+
+    sender.summary :time_start => month_ago, :time_end => now
+    sender.delivery :time_start => month_ago, :time_end => now, :limit => 10, :offset => 0
+    sender.campaigns :time_start => month_ago, :time_end => now
+    sender.complaints :time_start => month_ago, :time_end => now, :limit => 10, :offset => 0
+    sender.queue :time_start => month_ago, :time_end => now, :limit => 10, :offset => 0
+
+
+## Contributing to smtpcom_api
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Vasiliy Sablin. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,43 @@
+# encoding: utf-8
+$LOAD_PATH << "./lib/"
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+require 'smtpcom_api'
+
+Jeweler::Tasks.new do |gem|
+  gem.name = "smtpcom_api"
+  gem.homepage = "http://github.com/smtpcom/smtpcom_api"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby wrapper for the http://smtp.com API (http://api.smtp.com)}
+  gem.description = gem.description
+  gem.email = "vasiliy.sablin@gmail.com"
+  gem.authors = ["Vasiliy Sablin"]
+  gem.version = SmtpcomApi::Version::STRING
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = SmtpcomApi::Version::STRING
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "smtpcom_api #{version}"
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/examples/usage.rb

@@ -0,0 +1,61 @@
+require 'smtpcom_api'
+
+client = SmtpcomApi::Client.new('your_api_key', 'api_url')
+
+# Getting account
+account = client.account
+
+# Getting account attributes as hash
+account.attributes # or account.to_hash
+
+#updating account attributes:
+account.company_name = 'My Company'
+account.save
+
+# Getting senders
+senders = client.senders # OR senders = account.senders
+
+# Find one sender by label or id
+sender = client.sender('sender_label') # OR sender = account.sender('sender_label')
+
+# Get sender attributes as hash
+sener.attributes # OR sender.to_hash
+
+#update sender 
+sender.login    = 'new_login'
+sender.password = 'new_password1'
+sender.save
+
+#creating sender
+attributes = { 
+  :label      => 'my_label', 
+  :login      => 'my_login', 
+  :password   => 'my_password1',
+  :max_quota  => 10000
+}
+new_sender = client.add_sender attributes
+
+# Auth by IP
+# You could allow sender to login from some IP address instead of using login/pass each time
+# To do that you shold first set :is_ip_based attribute to true
+new_sender.is_ip_based = true
+new_sender.save
+# Then, add allowed IP addresse 
+new_sender.add_allowed_ip('222.178.23.97')
+# or remove some
+new_sender.remove_allowed_ip('222.178.23.97')
+
+
+# Examples how to get sender statistics data (summary/detailed delivery/campaigns/complaints/queue)
+now       = Time.now.to_i
+month_ago = now - 30*24*60*60
+
+sender.summary :time_start => month_ago, :time_end => now
+sender.delivery :time_start => month_ago, :time_end => now, :limit => 10, :offset => 0
+sender.campaigns :time_start => month_ago, :time_end => now
+sender.complaints :time_start => month_ago, :time_end => now, :limit => 10, :offset => 0
+sender.queue :time_start => month_ago, :time_end => now, :limit => 10, :offset => 0
+
+
+
+

data/lib/smtpcom_api.rb

@@ -0,0 +1,4 @@
+require 'smtpcom_api/client'
+require 'smtpcom_api/account'
+require 'smtpcom_api/sender'
+require 'smtpcom_api/version'

data/lib/smtpcom_api/account.rb

@@ -0,0 +1,34 @@
+module SmtpcomApi
+  class Account < Client
+    ACCESSORS  = [:company_name, :phone, :last_name, :first_name]
+    READERS    = [:email, :prepaid_quota, :reset_quota_at, :ip_pool, :usage]
+    ATTRIBUTES = READERS + ACCESSORS
+
+    include ::SmtpcomApi::Helpers
+
+    attr_accessor *ACCESSORS
+    attr_reader   *READERS
+
+    def initialize(api_key, api_host)
+      super
+      reload
+    end
+
+    def reload
+      set_attributes get(:account)['account']
+      self
+    end
+
+    def dashboard
+      st = @reset_quota_at.to_i>0 ? @reset_quota_at - 30*24*24 : now.to_i - 30*24*60*60
+      get(:dashboard, :time_end => now.to_i, :time_start => st)['dashboard']
+    end
+
+    def save
+      update = attributes.select{|k| ACCESSORS.include? k}
+      put :account, :account => update
+      self
+    end
+
+  end
+end

data/lib/smtpcom_api/client.rb

@@ -0,0 +1,33 @@
+require 'smtpcom_api/request'
+require 'smtpcom_api/helpers'
+
+module SmtpcomApi
+  class Client
+    include Request
+
+    attr_reader :api_key, :host
+
+    def initialize(api_key, api_host='http://api.smtp.com')
+      @api_key  = api_key
+      @api_host = api_host
+    end
+
+    def account
+      SmtpcomApi::Account.new(@api_key, @api_host)
+    end
+
+    def sender(label)
+      SmtpcomApi::Sender.new(label, @api_key, @api_host)
+    end
+
+    def add_sender(attributes)
+      SmtpcomApi::Sender.new(attributes[:label], @api_key, @api_host, post(:senders, :sender => attributes)['sender'])
+    end
+    alias_method :create_sender, :add_sender
+
+    def senders
+      get(:senders)['senders'].map{|s| SmtpcomApi::Sender.new(s['label'], @api_key, @api_host, s) }
+    end
+
+  end
+end

data/lib/smtpcom_api/helpers.rb

@@ -0,0 +1,21 @@
+module SmtpcomApi
+  module Helpers
+
+    def to_hash
+      self.class.const_get(:ATTRIBUTES).inject({}) do |r, k|
+        r.merge k => instance_variable_get("@#{k}")
+      end
+    end
+    alias_method :attributes, :to_hash
+
+    def set_attributes(attributes)
+      self.class.const_get(:ATTRIBUTES).each do |k|
+        instance_variable_set("@#{k}", attributes[k.to_s])
+      end
+    end
+
+    def now
+      Time.now
+    end
+  end
+end

data/lib/smtpcom_api/request.rb

@@ -0,0 +1,65 @@
+require 'faraday_middleware'
+require 'smtpcom_api/request/urls'
+
+module SmtpcomApi
+  module Request
+    
+    include Urls
+
+    API_PATH = '/v1'
+    FORMAT   = 'json'
+    HTTP_METHODS = [:get, :put, :post, :delete]
+
+    def method_missing(name, *args)
+      if HTTP_METHODS.include? name.to_sym
+        key    = args[0]
+        params = args[1] || {}
+        pl = params.delete(:pl)
+        _call(name, get_url(key, pl), process_params(params))
+      else 
+        super
+      end
+    end
+
+    def respond_to?(name)
+      if HTTP_METHODS.include? name.to_sym
+        true
+      else
+        super
+      end
+    end
+
+    private
+
+      def process_params(params)
+        params[:time_start] = params[:time_start].to_i if params[:time_start]
+        params[:time_end]   = params[:time_end].to_i   if params[:time_end]
+        params
+      end
+
+      def get_url(key, pl=[])
+        [@api_host, API_PATH, get_path(key, pl), ".#{FORMAT}"].join
+      end
+
+      def get_path(key, pl)
+        pl = [pl] unless pl.instance_of?(Array)
+        pl.map!{|s| CGI.escape(s.to_s).gsub(/\./,'%2E')}
+        Urls.const_get(key.to_s.upcase) % pl
+      end
+
+      def _call(method, path, params)
+        conn = Faraday.new do |c|
+          c.request :url_encoded
+          #c.response :logger
+          c.response :json
+          c.response :raise_error          
+          c.adapter :net_http
+        end
+        
+        res = conn.send(method, path, params.merge({:api_key => @api_key})).body
+        raise "Error #{res["code"]}: #{res["message"]}" unless res['code'] == 0
+        res
+      end
+
+  end
+end