socketlab 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in socketlab.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 amardaxini
+
+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,105 @@
+# Socketlab
+
+Ruby Wrapper Of Socketlabs api (http://www.socketlabs.com/api-reference/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'socketlab'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install socketlab
+
+## Usage
+
+### Set Socketlab Api User and Password
+
+    Socketlab.api_user=''
+    Socketlab.api_password=''
+
+
+### Get Account Data
+    # https://api.socketlabs.com/v1/accountData
+    account_data = Socketlab::AccountData.new
+    account_data.api_request({:serverId=>''})
+    account_data.set_response
+
+account object returns Current Billing Period Start,Current BillingPeriod End... etc attributes refer api
+
+###  Messages Failed
+
+
+    # https://api.socketlabs.com/v1/messagesFailed
+    # date_format yyyy-mm-dd hh:mm:ss  If the time is omitted it will default to 00:00:00.
+    # query=  {:serverId=>"required",:startDate=>date_format,:endDate=>date_format,:timeZone=> timeZone offset,
+    # mailingId=>"",:messageId=>"",:index=>"",:count=>"":type=>"JSON"}
+
+    message = Socketlab::MessageFailed.new
+    message.api_request(query)
+    message.set_response
+
+###  Messages Queued
+
+
+    # https://api.socketlabs.com/v1/messagesQueued
+    # date_format yyyy-mm-dd hh:mm:ss  If the time is omitted it will default to 00:00:00.
+    # query=  {:serverId=>"required",:startDate=>date_format,:endDate=>date_format,:timeZone=> timeZone offset,
+    # mailingId=>"",:messageId=>"",:index=>"",:count=>"":type=>"JSON"}
+
+    message = Socketlab::MessageQueued.new
+    message.api_request(query)
+    message.set_response
+
+###  Messages Processed
+
+    # https://api.socketlabs.com/v1/messagesProcessed
+    # date_format yyyy-mm-dd hh:mm:ss  If the time is omitted it will default to 00:00:00.
+    # query=  {:serverId=>"",:startDate=>date_format,:endDate=>date_format,:timeZone=> timeZone offset,
+    # mailingId=>"",:messageId=>"",:index=>"",:count=>"":type=>"JSON"}
+
+    message = Socketlab::MessageProcessed.new
+    message.api_request(query)
+    message.set_response
+
+###  Messages Fbl Reported
+
+    # https://api.socketlabs.com/v1/messagesFblReported
+    # date_format yyyy-mm-dd hh:mm:ss  If the time is omitted it will default to 00:00:00.
+    # query=  {:serverId=>"",:startDate=>date_format,:endDate=>date_format,:timeZone=> timeZone offset,
+    # mailingId=>"",:messageId=>"",:index=>"",:count=>"":type=>"JSON"}
+
+    message = Socketlab::FblReport.new
+    message.api_request(query)
+    message.set_response
+
+###  Messages Open Click
+
+    # https://api.socketlabs.com/v1/messagesOpenClick
+    # date_format yyyy-mm-dd hh:mm:ss  If the time is omitted it will default to 00:00:00.
+    # query=  {:serverId=>"",:startDate=>date_format,:endDate=>date_format,:timeZone=> timeZone offset,
+    # mailingId=>"",:messageId=>"",:index=>"",:count=>"":type=>"JSON"}
+
+    message = Socketlab::MessageOpenClick.new
+    message.api_request(query)
+    message.set_response
+
+It will Returns total count,pages,count,items colletion,timestamp
+Item collection has different attribute like timestamp,server id,to address,from address,message id .. etc depending upon api request, for more info refer api
+
+
+### Refer http://www.socketlabs.com/api-reference/ for reference for params
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/socketlab.rb

@@ -0,0 +1,33 @@
+require "socketlab/version"
+require "socketlab/socketklab_request"
+require "socketlab/item"
+require "socketlab/account_data"
+require "socketlab/message_failed"
+require "socketlab/message_failed_item"
+require "socketlab/message_queued"
+require "socketlab/message_queued_item"
+require "socketlab/message_processed"
+require "socketlab/message_processed_item"
+require "socketlab/fbl_report"
+require "socketlab/fbl_report_item"
+require "socketlab/message_open_click"
+require "socketlab/message_open_click_item"
+require "socketlab/utility"
+
+require 'httparty'
+module Socketlab
+  BASE_URI = "api.socketlabs.com"
+
+  class << self
+    def api_user=(v); @api_user = v; end
+    def api_user; @api_user; end
+
+    def api_password=(v); @api_password = v; end
+    def api_password; @api_password; end
+
+    def api_version=(v); @api_version = v; end
+    def api_version; @api_version; end
+
+  end
+end
+

data/lib/socketlab/account_data.rb

@@ -0,0 +1,37 @@
+module Socketlab
+  class AccountData < SocketlabRequest
+
+    attr_accessor :timestamp
+
+    #JSON, JSONP, XML or CSV
+    #query {:serverId=>"",:type=>"JSON"}
+    def api_request(query={:type=>"JSON"})
+      @query_params =query
+      socketlab_request("accountData")
+
+    end
+
+    #  Assuming type is json
+    #  Setting Instance variable Dynamicaly and adding attr_accessor
+    #  :server_id, :account_id, :plan_billing_period_start,:plan_billing_period_end,:billing_period_start,:billing_period_end,
+    # :billing_period_message_count,:billing_period_bandwidth_count_in_bytes,:billing_period_bandwidth_count_in_gigabytes,
+    # :billing_period_api_count,:api_allowance,:max_api_allowance,:message_allowance,:max_message_allowance,
+    # :bandwidth_allowance_in_bytes,:max_bandwidth_allowance_in_bytes,:bandwidth_allowance_in_gigabytes,
+    # :max_bandwidth_allowance_in_gigabytes,:is_over_api_allowance,:is_over_bandwidth_allowance,:is_over_message_allowance
+
+    def set_response
+      if @api_response.success?
+        @timestamp = @api_response["timestamp"]
+        unless @api_response["object"].nil?
+          @api_response["object"].each do |attr_key,attr_val|
+            self.class.send :attr_accessor ,attr_key.snake_case.to_sym
+            self.instance_variable_set("@#{attr_key.snake_case}".to_sym,attr_val)
+          end
+        end
+      else
+        @error = @api_response.parsed_response
+      end
+    end
+
+  end
+end

data/lib/socketlab/fbl_report.rb

@@ -0,0 +1,21 @@
+module Socketlab
+  class FblReport < SocketlabRequest
+
+    attr_accessor :total_count,:total_pages,:count,:items,:timestamp
+    #JSON, JSONP, XML or CSV
+    #date_format yyyy-mm-dd hh:mm:ss  If the time is omitted it will default to 00:00:00.
+    #query=  {:serverId=>"",:startDate=>date_format,:endDate=>date_format,:timeZone=> timeZone offset,
+    # mailingId=>"",:messageId=>"",:index=>"",:count=>"":type=>"JSON"}
+    def api_request(query={:type=>"JSON"})
+      @query_params = query
+      socketlab_request("messagesFblReported")
+    end
+
+     #  Assuming type is json
+    def set_response
+      super(FblReportItem)
+    end
+
+
+  end
+end

data/lib/socketlab/fbl_report_item.rb

@@ -0,0 +1,6 @@
+module Socketlab
+  class FblReportItem
+    include Socketlab::Item
+    attr_accessor :original_recipient,:type,:user_agent
+  end
+end

data/lib/socketlab/item.rb

@@ -0,0 +1,20 @@
+module Socketlab
+  module Item
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      attr_accessor :server_id,:date_time,:message_id,:mailing_id,:to_address,:from_address
+    end
+
+    def set_item(item_hash)
+      item_hash.each do |attr_key,attr_val|
+        item_attr = "@#{attr_key.snake_case}".to_sym
+        self.instance_variable_set(item_attr,attr_val)
+      end
+    end
+
+  end
+end

data/lib/socketlab/message_failed.rb

@@ -0,0 +1,19 @@
+module Socketlab
+  class MessageFailed < SocketlabRequest
+
+    #JSON, JSONP, XML or CSV
+    #date_format yyyy-mm-dd hh:mm:ss  If the time is omitted it will default to 00:00:00.
+    #query=  {:serverId=>"",:startDate=>date_format,:endDate=>date_format,:timeZone=> timeZone offset,
+    # mailingId=>"",:messageId=>"",:index=>"",:count=>"":type=>"JSON"}
+    def api_request(query={:type=>"JSON"})
+      @query_params = query
+      socketlab_request("messagesFailed")
+    end
+
+     #  Assuming type is json
+    def set_response
+      super(MessageFailedItem)
+    end
+
+  end
+end

data/lib/socketlab/message_failed_item.rb

@@ -0,0 +1,6 @@
+module Socketlab
+  class MessageFailedItem
+    include Socketlab::Item
+    attr_accessor :failure_type,:failure_code,:reason
+  end
+end

data/lib/socketlab/message_open_click.rb

@@ -0,0 +1,18 @@
+module Socketlab
+  class MessageOpenClick < SocketlabRequest
+    #JSON, JSONP, XML or CSV
+    #date_format yyyy-mm-dd hh:mm:ss  If the time is omitted it will default to 00:00:00.
+    #query=  {:serverId=>"",:startDate=>date_format,:endDate=>date_format,:timeZone=> timeZone offset,
+    # mailingId=>"",:messageId=>"",:index=>"",:count=>"":type=>"JSON"}
+    def api_request(query={:type=>"JSON"})
+      @query_params = query
+      socketlab_request("messagesOpenClick")
+    end
+
+     #  Assuming type is json
+    def set_response
+      super(MessageOpenClickItem)
+    end
+
+  end
+end

data/lib/socketlab/message_open_click_item.rb

@@ -0,0 +1,6 @@
+module Socketlab
+  class MessageOpenClickItem
+    include Socketlab::Item
+    attr_accessor :original_recipient,:event_type
+  end
+end

data/lib/socketlab/message_processed.rb

@@ -0,0 +1,22 @@
+module Socketlab
+  class MessageProcessed < SocketlabRequest
+
+    #JSON, JSONP, XML or CSV
+    #date_format yyyy-mm-dd hh:mm:ss  If the time is omitted it will default to 00:00:00.
+    #query=  {:serverId=>"",:startDate=>date_format,:endDate=>date_format,:timeZone=> timeZone offset,
+    # mailingId=>"",:messageId=>"",:index=>"",:count=>"":type=>"JSON"}
+
+    def api_request(query={:type=>"JSON"})
+      @query_params = query
+      socketlab_request("messagesProcessed")
+
+    end
+
+    #  Assuming type is json
+    def set_response
+      super(MessageProcessedItem)
+    end
+
+
+  end
+end

data/lib/socketlab/message_processed_item.rb

@@ -0,0 +1,6 @@
+module Socketlab
+  class MessageProcessedItem
+    include Socketlab::Item
+    attr_accessor :disposition,:local_ip,:message_size,:response
+  end
+end

data/lib/socketlab/message_queued.rb

@@ -0,0 +1,20 @@
+module Socketlab
+  class MessageQueued < SocketlabRequest
+    #JSON, JSONP, XML or CSV
+    #date_format yyyy-mm-dd hh:mm:ss  If the time is omitted it will default to 00:00:00.
+    #query=  {:serverId=>"",:startDate=>date_format,:endDate=>date_format,:timeZone=> timeZone offset,
+    # mailingId=>"",:messageId=>"",:index=>"",:count=>"":type=>"JSON"}
+
+    def api_request(query={:type=>"JSON"})
+      @query_params = query
+      socketlab_request("messagesQueued")
+    end
+
+    #  Assuming type is json
+    def set_response
+      super(MessageQueuedItem)
+    end
+
+
+  end
+end

data/lib/socketlab/message_queued_item.rb

@@ -0,0 +1,6 @@
+module Socketlab
+  class MessageQueuedItem
+    include Socketlab::Item
+    attr_accessor :message_size,:failure_code,:reason
+  end
+end

data/lib/socketlab/socketklab_request.rb

@@ -0,0 +1,55 @@
+module Socketlab
+  class SocketlabRequest
+    attr_accessor :api_user,:api_password,:api_server,:api_version,:query_params,:error
+    attr_accessor :total_count,:total_pages,:count,:items,:timestamp
+
+    def initialize(api_user = nil, api_key = nil,api_server=nil,api_version=nil)
+      @api_user = api_user || Socketlab.api_user
+      @api_password = api_password || Socketlab.api_password
+      @api_version = api_version || Socketlab.api_version || "v1"
+
+    end
+
+    def socketlab_request(module_name)
+      @api_response =HTTParty.get("https://#{BASE_URI}/#{@api_version}/#{module_name}", set_request_options)
+    end
+
+    #default response type is json
+    def set_query_params_type
+      @query_params[:type]= @query_params[:type] || "json"
+    end
+
+    def set_request_options
+      set_query_params_type
+      options= {}
+      options[:query] = @query_params
+      options[:basic_auth] = {:username => @api_user, :password => @api_password}
+      options
+    end
+
+    #  Assuming type is json
+    def set_response(item_class_name)
+      if @api_response.success?
+        @total_count = @api_response["totalCount"]
+        @total_pages = @api_response["totalPages"]
+        @count = @api_response["count"]
+        @timestamp = @api_response["timestamp"]
+        @items = []
+        unless @api_response["collection"].nil?
+          @api_response["collection"].each do |attr_item|
+            item = item_class_name.new
+            item.set_item(attr_item)
+            @items << item
+          end
+        end
+      else
+        @error = @api_response.parsed_response
+      end
+    end
+
+    def error?
+      @api_response.success?
+    end
+
+  end
+end

data/lib/socketlab/utility.rb

@@ -0,0 +1,8 @@
+class String
+  def snake_case
+    return downcase if match(/\A[A-Z]+\z/)
+    gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+    gsub(/([a-z])([A-Z])/, '\1_\2').
+    downcase
+  end
+end

data/lib/socketlab/version.rb

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

data/socketlab.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'socketlab/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "socketlab"
+  gem.version       = Socketlab::VERSION
+  gem.authors       = ["amardaxini"]
+  gem.email         = ["amardaxini@gmail.com"]
+  gem.description   = %q{Ruby Wrapper Of Socketlabs API}
+  gem.summary       = %q{Ruby Wrapper Of Socketlabs API}
+  gem.homepage      = "https://github.com/amardaxini/socketlab"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency('httparty')
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: socketlab
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- amardaxini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby Wrapper Of Socketlabs API
+email:
+- amardaxini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/socketlab.rb
+- lib/socketlab/account_data.rb
+- lib/socketlab/fbl_report.rb
+- lib/socketlab/fbl_report_item.rb
+- lib/socketlab/item.rb
+- lib/socketlab/message_failed.rb
+- lib/socketlab/message_failed_item.rb
+- lib/socketlab/message_open_click.rb
+- lib/socketlab/message_open_click_item.rb
+- lib/socketlab/message_processed.rb
+- lib/socketlab/message_processed_item.rb
+- lib/socketlab/message_queued.rb
+- lib/socketlab/message_queued_item.rb
+- lib/socketlab/socketklab_request.rb
+- lib/socketlab/utility.rb
+- lib/socketlab/version.rb
+- socketlab.gemspec
+homepage: https://github.com/amardaxini/socketlab
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Ruby Wrapper Of Socketlabs API
+test_files: []