racked 0.9.0 → 1.0.0

data/Gemfile

@@ -11,3 +11,8 @@ group :development do
   gem "jeweler", "~> 1.5.1"
   gem "rcov", ">= 0"
 end
+
+gem "rspec"
+gem "rdoc"
+
+gem "syntax"

data/Gemfile.lock

@@ -1,14 +1,27 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    diff-lcs (1.1.3)
     git (1.2.5)
-    jeweler (1.5.1)
+    jeweler (1.5.2)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
-    rake (0.8.7)
-    rcov (0.9.9)
+    json (1.6.3)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rdoc (3.11)
+      json (~> 1.4)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
     shoulda (2.11.3)
+    syntax (1.0.0)
 
 PLATFORMS
   ruby
@@ -17,4 +30,7 @@ DEPENDENCIES
   bundler (~> 1.0.0)
   jeweler (~> 1.5.1)
   rcov
+  rdoc
+  rspec
   shoulda
+  syntax

data/README.rdoc

@@ -21,17 +21,39 @@ further details.
 
 #gem install racked
 
-In your config file e.g "mailapi.yml"
-server: 'api.emailsrvr.com'
-version_prefix: '/v0'
-user_key: 'xxxxxxx'
-secret_hash: 'xxxxxxx
-
-In your initializer or before you call the API
-require 'yaml' #depending on your situation
-MAIL_CFG = YAML::load(File.read('path_to/mailapi.yml'))
 
 == Usage:
 
-api = Racked.new
-mailboxes = api.get_mailmoxes # => [{"name"=>"tomthumb", "displayName"=>"Tom Thumb"}, {"name"=>"dicktracy", "displayName"=>"Dick Tracy"}]
+@valid_attr = {
+  :server_host    => 'api.emailsrvr.com',
+  :version_prefix => '/v0',
+  :user_key       => 'xxxxxxx',
+  :secret_hash    => 'xxxxxxx',
+}
+api = Racked.new(@valid_attr)
+
+Add Customer Account
+opts = {:data_fields_hash => {:name => "Foo Bar Corp", :referenceNumber => "0001"}}
+api.add_customer(opts)
+
+Add Domain
+opts = {
+		:domain           => "foobar.com", 
+		:customer_number  => "xxxxx", 
+		:data_fields_hash => { 
+								"serviceType"            => "exchange", # Domain service type. "rsemail" = "Rackspace Email Only". "exchange" = "Exchange Only". "both" = "Rackspace Email and Exchange"
+								:exchangeMaxNumMailboxes => "5" 
+							}
+		}
+
+Create Mailbox
+ops = {
+		:domain           => "foobar.com", 
+		:mailbox_type     => "ex", 
+		:customer_number  => "xxxxx", 
+		:mailbox          => "tthumb", 
+		:data_fields_hash => {:password => '10G0t0Sa', :displayName => "Tom Thumb", :size => "2048"}
+	  }
+api.create_mailbox(opts)
+
+...

data/Rakefile

@@ -8,7 +8,7 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require 'rake'
-
+include Rake::DSL
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
@@ -42,10 +42,13 @@ Rcov::RcovTask.new do |test|
   test.verbose = true
 end
 
-task :default => :test
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'

data/VERSION

@@ -1 +1 @@
-0.9.0
+1.0.0

data/lib/racked.rb

@@ -32,20 +32,32 @@ end
 class Racked
   #include Singleton
   
-  def initialize
+  attr_accessor :server_host, :version_prefix, :user_key, :secret_hash
+  
+  def initialize(options)
+    check_options(options, [:server_host, :version_prefix, :user_key, :secret_hash])
+    @server_host = options[:server_host]
+    @version_prefix = options[:version_prefix]
+    @user_key = options[:user_key]
+    @secret_hash = options[:secret_hash]
     #read config file
-    
-    @server = Server.new(MAIL_CFG["server"], MAIL_CFG["version_prefix"], MAIL_CFG["user_key"], MAIL_CFG["secret_hash"])
+    # @server = Server.new(MAIL_CFG["server"], MAIL_CFG["version_prefix"], MAIL_CFG["user_key"], MAIL_CFG["secret_hash"])
+    @server = Server.new(options[:server_host], options[:version_prefix], options[:user_key], options[:secret_hash])
     @server.xml_format
+        
   end
   
-  def get_domain_info
-    response = @server.get  '/customers/856863/domains/econetmail.com', @server.json_format
+  def get_domain_info(options)
+    check_options(options, [:domain, :customer_number])
+    response = @server.get  "/customers/#{@customer_number}/domains/#{@domain}", @server.json_format
   end
   
   def get_mailboxes(size=50, offset=0)
+    check_options(options, [:domain, :customer_number, :mailbox_type])
+    size = options[:size] || 50
+    offset = options[:offset] || 0
     #get customer list
-    response = @server.get  '/customers/856863/domains/econetmail.com/rs/mailboxes/?size=' + size.to_s + '&offset=' + offset.to_s, @server.json_format
+    response = @server.get  "/customers/#{@customer_number}/domains/#{@domain}/#{@mailbox_type}/mailboxes/?size=" + size.to_s + '&offset=' + offset.to_s, @server.json_format
     puts response.inspect
     # puts response['x-error-message']
     # puts response.body
@@ -62,10 +74,11 @@ class Racked
       mailboxes << mailbox
     end
   end
-  def get_mailbox_details(mailbox, account_details = {})
-    self.check_account_details(account_details)
+  def get_mailbox_details(options)
+    check_options(options, [:domain, :customer_number, :mailbox_type, :mailbox])
+    
     #get mailbox details
-    response = @server.get  '/customers/856863/domains/econetmail.com/rs/mailboxes/' + mailbox, @server.json_format
+    response = @server.get  "/customers/#{@customer_number}/domains/#{@domain}/#{@mailbox_type}/mailboxes/" + @mailbox, @server.json_format
     puts response.inspect
     puts response['x-error-message']
     # response = JSON.parse(response)
@@ -79,21 +92,25 @@ class Racked
     return response
   end
   
-  def get_last_login(account_details = {}, mailbox)
-    raise ArgumentError, "account_details hash must be supplied." unless !account_details.empty?
+  def get_last_login(account_details_for_soap = {}, mailbox)
+    #TO DO: need to rethink
+    check_options(options, [:mailbox])
+    
+    self.account_details_for_soap(options[:account_details])
     driver = UtilsSoapPort.new
     # driver.wiredump_dev = STDOUT
 
-    res = driver.GetUserLastLogin(account_details[:resellerUsername], account_details[:resellerPassword], account_details[:hostName], mailbox, account_details[:lastlogin])
+    res = driver.GetUserLastLogin(@account_details[:resellerUsername], @account_details[:resellerPassword], @account_details[:hostName], @mailbox, @account_details[:lastlogin])
     # if res[1].class == String && !res[1].empty?
     #   puts "yes"
     # end
     return res
   end
 
-  def create_mailbox(msisdn_number, fields_array)
+  def create_mailbox(options)
+    check_options(options, [:domain, :customer_number, :mailbox_type, :mailbox, :data_fields_hash])
     #create a customer mailbox
-    response = @server.post  '/customers/856863/domains/econetmail.com/rs/mailboxes/' + msisdn_number, fields_array
+    response = @server.post  "/customers/#{@customer_number}/domains/#{@domain}/#{@mailbox_type}/mailboxes/#{@mailbox}", @data_fields_hash, @server.json_format
     # puts response.inspect
     # puts response['x-error-message']
     # puts response.body.inspect
@@ -101,9 +118,10 @@ class Racked
     #response = JSON.parse(response.body )
   end
 
-  def update_mailbox(msisdn_number, fields_array)
-    #create a customer mailbox
-    response = @server.put  '/customers/856863/domains/econetmail.com/rs/mailboxes/' + msisdn_number, fields_array
+  def update_mailbox(options)
+    check_options(options, [:domain, :customer_number, :mailbox_type, :mailbox, :data_fields_hash])
+    #update a customer mailbox
+    response = @server.put  "/customers/#{@customer_number}/domains/#{@domain}/#{@mailbox_type}/mailboxes/#{@mailbox}", @data_fields_hash
     # puts response.inspect
     # puts response['x-error-message']
     # puts response.body.inspect
@@ -111,9 +129,10 @@ class Racked
     #response = JSON.parse(response.body )
   end
   
-  def delete_mailbox(msisdn)
-    #create a customer mailbox
-    response = @server.delete  '/customers/856863/domains/econetmail.com/rs/mailboxes/' + msisdn
+  def delete_mailbox(options)
+    #delete a customer mailbox
+    check_options(options, [:domain, :customer_number, :mailbox_type, :mailbox])
+    response = @server.delete  "/customers/#{@customer_number}/domains/#{@domain}/#{@mailbox_type}/mailboxes/#{@mailbox}"
     # puts response.inspect
     # puts response['x-error-message']
     # puts response.body.inspect
@@ -121,10 +140,40 @@ class Racked
     #response = JSON.parse(response.body )
   end
   
+  def add_customer(options)
+    check_options(options, [:data_fields_hash])
+    #add a customer account
+    response = @server.post  "/customers", @data_fields_hash, @server.json_format
+    return response
+  end
+  def add_domain(options)
+    check_options(options, [:domain, :customer_number, :data_fields_hash])
+    #add a customer account
+    response = @server.post  "/customers/#{@customer_number}/domains/#{@domain}", @data_fields_hash, @server.json_format
+    return response
+  end
+
   private
   def check_account_details(account_details)
     raise ArgumentError, 'Argument missing! account_details[:customer_number] missing.' unless account_details[:customer_number].empty? || account_details.include?(:customer_number)
     raise ArgumentError, 'Argument missing! account_details[:domain_name] missing.' unless account_details[:domain_name].empty? || account_details.include?(:domain_name)
+    @account_details = account_details
+  end
+  
+  def check_options(supplied_options_hash, options_to_check)
+    supplied_options_hash[:mailbox_type] ||= "rs"
+    missing_options = []
+    options_to_check.each do |opt|
+      missing_options << opt if !supplied_options_hash[opt] || supplied_options_hash[opt].empty?
+    end
+    raise ArgumentError, "Argument(s) missing! You need to supply :#{missing_options.join(", :")}" unless missing_options.empty?
+
+    @customer_number  = supplied_options_hash[:customer_number]
+    @domain           = supplied_options_hash[:domain]
+    @mailbox_type     = supplied_options_hash[:mailbox_type]
+    @mailbox          = supplied_options_hash[:mailbox]
+    @data_fields_hash = supplied_options_hash[:data_fields_hash]
+
   end
   
 

data/lib/racked/server.rb

@@ -50,9 +50,11 @@ class Server
     http_response = make_request request, uri
   end
   
-  def post(url_string, fields_hash)
+  def post(url_string, fields_hash, format)
     uri = full_uri(url_string)
-    request = Net::HTTP::Post.new(request_uri(uri), prepared_headers)
+    headers = prepared_headers
+    headers['Accept'] = format
+    request = Net::HTTP::Post.new(request_uri(uri), headers)
     request.set_form_data(fields_hash)
     http_response = make_request request, uri
   end

data/lib/soap_api/mailaccountsDriver.rb

@@ -1,3 +1,4 @@
+$:.unshift(File.dirname(__FILE__))
 require 'mailaccounts.rb'
 require 'mailaccountsMappingRegistry.rb'
 require 'soap/rpc/driver'

data/spec/racked_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Racked do
+  before(:each) do
+    @valid_attr = {
+      :server_host    => 'api.emailsrvr.com',
+      :version_prefix => '/v0',
+      :user_key       => 'xxxxxxx',
+      :secret_hash    => 'xxxxxxx',
+    }
+    @invalid_attr = {}
+  end
+  
+  it 'should throw argument errors when initialized with no options' do
+    expect{ Racked.new }.to raise_error(ArgumentError)
+  end
+  it 'should throw argument errors if the required options are missing' do
+    expect{ Racked.new(@invalid_attr) }.to raise_error(ArgumentError)
+  end
+
+  it 'should initialize if the required options are supplied' do
+    api = Racked.new(@valid_attr)
+    api.class.should == Racked
+  end
+  # it 'should respond to attributes' do
+  #   api = Racked.new(@valid_attr)
+  #   api.should respond_to(:domain, :mailbox_type, :customer_number)
+  # end
+  it 'should assign attributes' do
+    api = Racked.new(@valid_attr)
+    api.server_host.should == "api.emailsrvr.com"
+  end
+
+end

data/spec/spec_helper.rb

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

metadata

@@ -3,10 +3,10 @@ name: racked
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
+  - 1
   - 0
-  - 9
   - 0
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Noto Modungwa
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-06 00:00:00 +02:00
+date: 2011-12-05 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: shoulda
+  name: rspec
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -27,12 +27,51 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: rdoc
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: syntax
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -44,10 +83,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id002
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -59,10 +98,10 @@ dependencies:
         version: 1.5.1
   type: :development
   prerelease: false
-  version_requirements: *id003
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: rcov
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -72,7 +111,7 @@ dependencies:
         version: "0"
   type: :development
   prerelease: false
-  version_requirements: *id004
+  version_requirements: *id007
 description: Allows you to manage your rackspace hosted mailboxes, eg. create a new mailbox.
 email: notomodungwa@gmail.com
 executables: []
@@ -97,6 +136,8 @@ files:
 - lib/soap_api/mailaccountsMappingRegistry.rb
 - test/helper.rb
 - test/test_racked.rb
+- spec/racked_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/NoTiTo/racked
 licenses: 
@@ -112,7 +153,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2410697322953732488
+      hash: -3169237959093835828
       segments: 
       - 0
       version: "0"
@@ -132,5 +173,7 @@ signing_key:
 specification_version: 3
 summary: Rackspace mailbox management API
 test_files: 
+- spec/racked_spec.rb
+- spec/spec_helper.rb
 - test/helper.rb
 - test/test_racked.rb