mxhero-api 0.1.1 → 0.1.2

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+coverage/
+pkg/

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create 1.9.3@mxhero-api

data/Gemfile

@@ -2,6 +2,11 @@
 source "https://rubygems.org"
 
 gem 'rake', '10.1.0'
+gem 'version'
+
+group :test do
+	gem 'simplecov', :require => false
+end
 
 # Specify your gem's dependencies in mxhero-api.gemspec
 gemspec

data/Rakefile

@@ -1,8 +1,39 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'rake/version_task'
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
 end
 
 task :default => :test
+
+
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('./lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+spec = Gem::Specification.new do |gem|
+  gem.name = 'mxhero-api'
+  gem.authors = ['Maximiliano Dello Russo', 'Juan Pablo Royo', 'mxHero']
+  gem.email = ['maxidr@mxhero.com','juanpablo.royo@gmail.com', 'mxhero@mxhero.com']
+  gem.summary = %q{A MxHero API client for ruby}
+  gem.description = %q{A gem to provide easy access to the API of MxHero platform (http://www.mxhero.com/)}
+  gem.homepage = 'http://github.com/mxhero/mxhero-api'
+
+  gem.files = `git ls-files`.split($\)
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency('vcr', '2.5.0') 
+  gem.add_development_dependency('webmock', '1.11.0')
+  
+  gem.add_dependency('httpclient', '2.3.3')
+
+end
+
+Rake::VersionTask.new do |task|
+  task.with_git_tag = true
+  task.with_gemspec = spec
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/lib/mxhero-api.rb

@@ -85,6 +85,24 @@ module MxHero
         response_as_a_hash 
       end
 
+      # Retrive the domain by id according to the parameter if exist
+      #
+      # @param id The domain name or id. For example: 'mydomain.com'
+      # @return [Hash] with the domain attributes if exist
+      #   * :domain [String]
+      #   * :server [String]
+      #   * :creationDate [Fixnum]
+      #   * :updateDate [Fixnum]
+      #   * :aliases 
+      #   * :ldap
+      # @raise an exception when the status code isn't 200
+      def domain_by_id(id = nil)
+        raise 'Id domain could not be nil' if id.nil?
+        response = call(:get, domain_by_id_url(id))
+        response_as_a_hash = json_parse(response.content)
+        response_as_a_hash 
+      end
+
      
       def verbose?
         @verbose
@@ -164,7 +182,9 @@ module MxHero
       def call(method, url, body = nil)
         client = HTTPClient.new
         client.set_auth(url, @username, @password)
-        client.request(method, url, nil, body, headers)
+        response = client.request(method, url, nil, body, headers)
+        raise 'an error ocurred when try to communicate with the API' if 500..600.include?(response.status)
+        response
       end
 
       # Default headers
@@ -184,6 +204,10 @@ module MxHero
         service_url + '/domains'
       end
 
+      def domain_by_id_url(domain)
+        domains_url + "/#{domain}/"
+      end
+
       def domain_rule_url(domain, id)
         rules_for_domain_url(domain) + "/#{id}"
       end

data/mxhero-api.gemspec

@@ -1,20 +1,36 @@
+# -*- encoding: utf-8 -*-
 
-Gem::Specification.new do |gem|
-  gem.name = 'mxhero-api'
-  gem.version = '0.1.1'
-  gem.authors = ['Maximiliano Dello Russo']
-  gem.email = ['maxidr@mxhero.com']
-  gem.summary = %q{A MxHero API client for ruby}
-  gem.description = %q{A gem to provide easy access to the API of MxHero platform (http://www.mxhero.com/)}
-  gem.homepage = 'http://github.com/mxhero/mxhero-api'
+Gem::Specification.new do |s|
+  s.name = "mxhero-api"
+  s.version = "0.1.2"
 
-  gem.files = `git ls-files`.split($\)
-  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Maximiliano Dello Russo", "Juan Pablo Royo", "mxHero"]
+  s.date = "2013-08-07"
+  s.description = "A gem to provide easy access to the API of MxHero platform (http://www.mxhero.com/)"
+  s.email = ["maxidr@mxhero.com", "juanpablo.royo@gmail.com", "mxhero@mxhero.com"]
+  s.files = [".gitignore", ".rvmrc", "Gemfile", "README.md", "Rakefile", "VERSION", "lib/mxhero-api.rb", "mxhero-api.gemspec", "test/fixtures/api/create_rule_alredy_exist.yml", "test/fixtures/api/create_rule_for_domain.yml", "test/fixtures/api/create_rule_success.yml", "test/fixtures/api/domain_by_id.yml", "test/fixtures/api/domain_by_id_not_found.yml", "test/fixtures/api/domain_rule.yml", "test/fixtures/api/domains.yml", "test/fixtures/api/rules_for_domain.yml", "test/fixtures/api/service_create_footer.yml", "test/fixtures/api/service_footer_for_domain.yml", "test/fixtures/api/update_rule.yml", "test/helper.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb"]
+  s.homepage = "http://github.com/mxhero/mxhero-api"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.25"
+  s.summary = "A MxHero API client for ruby"
+  s.test_files = ["test/fixtures/api/create_rule_alredy_exist.yml", "test/fixtures/api/create_rule_for_domain.yml", "test/fixtures/api/create_rule_success.yml", "test/fixtures/api/domain_by_id.yml", "test/fixtures/api/domain_by_id_not_found.yml", "test/fixtures/api/domain_rule.yml", "test/fixtures/api/domains.yml", "test/fixtures/api/rules_for_domain.yml", "test/fixtures/api/service_create_footer.yml", "test/fixtures/api/service_footer_for_domain.yml", "test/fixtures/api/update_rule.yml", "test/helper.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb"]
 
-  gem.add_development_dependency('vcr', '2.5.0') 
-  gem.add_development_dependency('webmock', '1.11.0')
-  
-  gem.add_dependency('httpclient', '2.3.3')
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
 
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<vcr>, ["= 2.5.0"])
+      s.add_development_dependency(%q<webmock>, ["= 1.11.0"])
+      s.add_runtime_dependency(%q<httpclient>, ["= 2.3.3"])
+    else
+      s.add_dependency(%q<vcr>, ["= 2.5.0"])
+      s.add_dependency(%q<webmock>, ["= 1.11.0"])
+      s.add_dependency(%q<httpclient>, ["= 2.3.3"])
+    end
+  else
+    s.add_dependency(%q<vcr>, ["= 2.5.0"])
+    s.add_dependency(%q<webmock>, ["= 1.11.0"])
+    s.add_dependency(%q<httpclient>, ["= 2.3.3"])
+  end
 end

data/test/fixtures/api/domain_by_id.yml

@@ -0,0 +1,36 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://admin:password@localhost:8080/webapi/api/v1/domains/test.com/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic YWRtaW46cGFzc3dvcmQ=
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0s=
+    headers:
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "U2VydmVy":
+      - !binary |-
+        SmV0dHkoNi4xLjEwKQ==
+    body:
+      encoding: US-ASCII
+      string: ! '{"domain":"test.com","server":"smtp.server","creationDate":1360096371000,"updatedDate":1360096371000,"aliases":["test.com"],"ldap":null}'
+    http_version: 
+  recorded_at: Wed, 07 Aug 2013 17:55:32 GMT
+recorded_with: VCR 2.5.0

data/test/fixtures/api/domain_by_id_not_found.yml

@@ -0,0 +1,36 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://admin:password@localhost:8080/webapi/api/v1/domains/test.notfound.com/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic YWRtaW46cGFzc3dvcmQ=
+  response:
+    status:
+      code: 404
+      message: !binary |-
+        Tm90IEZvdW5k
+    headers:
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "U2VydmVy":
+      - !binary |-
+        SmV0dHkoNi4xLjEwKQ==
+    body:
+      encoding: US-ASCII
+      string: ! '{"status":404,"code":404,"message":"domain.not.found","developerMessage":"domain.not.found","moreInfoUrl":"mailto:support@mxhero.com"}'
+    http_version: 
+  recorded_at: Wed, 07 Aug 2013 18:00:41 GMT
+recorded_with: VCR 2.5.0

data/test/helper.rb

@@ -1,3 +1,9 @@
+if ENV['COVERAGE'] == '1'
+  require 'simplecov'
+  SimpleCov.start do
+	add_filter "/test/"
+  end
+end
 require 'minitest/autorun'
 require 'minitest/pride'
 

data/test/test_mxhero_api.rb

@@ -1,4 +1,4 @@
-require_relative 'helper'
+  require_relative 'helper'
 
 class MxHeroAPITest < MiniTest::Unit::TestCase
 
@@ -46,6 +46,30 @@ class MxHeroAPITest < MiniTest::Unit::TestCase
     end
   end
 
+  def test_domain_by_id
+    VCR.use_cassette('domain_by_id') do
+      id = "test.com"
+      tesla_domain = @api.domain_by_id(id)
+      assert tesla_domain.key?(:domain)
+      assert tesla_domain.key?(:server)
+      assert tesla_domain.key?(:creationDate)
+      assert tesla_domain.key?(:aliases)
+      assert tesla_domain.key?(:ldap)
+    end
+  end
+
+  def test_domain_by_id_not_found
+    VCR.use_cassette('domain_by_id_not_found') do
+      id = "test.notfound.com"
+      tesla_domain = @api.domain_by_id(id)
+      assert tesla_domain[:status] == 404
+    end
+  end
+
+  def test_domain_by_id_param_could_not_be_nil
+    assert_raises(RuntimeError) { @api.domain_by_id }
+  end
+
   def rule_msg_with_domain(domain)
     msg = create_rule_msg
     msg[:domain] = domain

metadata

@@ -1,15 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: mxhero-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
 - Maximiliano Dello Russo
+- Juan Pablo Royo
+- mxHero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-12 00:00:00.000000000 Z
+date: 2013-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
@@ -62,19 +64,25 @@ dependencies:
 description: A gem to provide easy access to the API of MxHero platform (http://www.mxhero.com/)
 email:
 - maxidr@mxhero.com
+- juanpablo.royo@gmail.com
+- mxhero@mxhero.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .rvmrc
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
+- VERSION
 - lib/mxhero-api.rb
 - mxhero-api.gemspec
 - test/fixtures/api/create_rule_alredy_exist.yml
 - test/fixtures/api/create_rule_for_domain.yml
 - test/fixtures/api/create_rule_success.yml
+- test/fixtures/api/domain_by_id.yml
+- test/fixtures/api/domain_by_id_not_found.yml
 - test/fixtures/api/domain_rule.yml
 - test/fixtures/api/domains.yml
 - test/fixtures/api/rules_for_domain.yml
@@ -96,6 +104,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1666481203265487076
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -104,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A MxHero API client for ruby
@@ -112,6 +123,8 @@ test_files:
 - test/fixtures/api/create_rule_alredy_exist.yml
 - test/fixtures/api/create_rule_for_domain.yml
 - test/fixtures/api/create_rule_success.yml
+- test/fixtures/api/domain_by_id.yml
+- test/fixtures/api/domain_by_id_not_found.yml
 - test/fixtures/api/domain_rule.yml
 - test/fixtures/api/domains.yml
 - test/fixtures/api/rules_for_domain.yml
@@ -121,4 +134,3 @@ test_files:
 - test/helper.rb
 - test/test_mxhero_api.rb
 - test/test_mxhero_api_response.rb
-has_rdoc: 

data/Gemfile.lock

@@ -1,26 +0,0 @@
-PATH
-  remote: .
-  specs:
-    mxhero-api (0.1.1)
-      httpclient (= 2.3.3)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.3.4)
-    crack (0.3.2)
-    httpclient (2.3.3)
-    rake (10.1.0)
-    vcr (2.5.0)
-    webmock (1.11.0)
-      addressable (>= 2.2.7)
-      crack (>= 0.3.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  mxhero-api!
-  rake (= 10.1.0)
-  vcr (= 2.5.0)
-  webmock (= 1.11.0)