mxhero-api 0.1.6 → 0.1.7

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.1.7

data/lib/mxhero-api.rb

@@ -196,8 +196,46 @@ module MxHero
         return false
       end
 
+      # @param [String] domain
+      # @param [String] account  Ex.: test or mxhero (the user name)
+      # @return [MxHero::API::Response] reponse
+      #   the key :msg contains a Hash with the key, value of any property.
+      #   Example:
+      #       
+      #       { 'email': 'test@mxhero.com', 'name': 'John', 'lastname': 'Doe', ... }
+      #
+      def account_properties(domain, account)
+        url = account_properties_url(domain, account)
+        response = call(:get, url)
+        if response.status == 200
+          props = {}
+          json_parse(response.content).each { |property| props[property[:name]] = property[:value] }
+          return Response.new(response.code, props)
+        end
+        parse_response(response)
+      end
+
+      # @param [String] domain
+      # @param [String] account
+      # @param [Hash] properties The properties of the account. Ex.: { 'email': 'test@mxhero.com', 'name': 'John', 'lastname': 'Doe', ... }
+      #
+      # @return [MxHero::API::Response]. On success not return msg.
+      def update_account_properties(domain, account, properties)
+        url = account_properties_url(domain, account)
+        response = call(:put, url, account_properties_to_json(properties))
+        parse_response(response)
+      end
+
       private
 
+      def account_properties_to_json(properties)
+        out = []
+        properties.each do |key, value|
+          out << { name: key, value: value }
+        end
+        out.to_json
+      end
+
       # @return [MxHero::API::Response] a response object
       def parse_response(response, opts = { on_empty: nil })
         json = response.content
@@ -255,6 +293,10 @@ module MxHero
         rules_for_domain_url(domain) + "/#{id}"
       end
 
+      def account_properties_url(domain, account)
+        accounts_by_domain_url(domain) + "/#{account}/properties"
+      end
+
       def service_url
         @service_url
       end

data/mxhero-api.gemspec

@@ -2,20 +2,20 @@
 
 Gem::Specification.new do |s|
   s.name = "mxhero-api"
-  s.version = "0.1.6"
+  s.version = "0.1.7"
 
   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-13"
+  s.date = "2013-08-14"
   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", "LICENSE.txt", "README.md", "Rakefile", "VERSION", "lib/mxhero-api.rb", "mxhero-api.gemspec", "test/fixtures/api/accounts_from_domain.yml", "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/delete_rule.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/update_rule.yml", "test/helper.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb"]
+  s.files = [".gitignore", ".rvmrc", "Gemfile", "LICENSE.txt", "README.md", "Rakefile", "VERSION", "lib/mxhero-api.rb", "mxhero-api.gemspec", "test/fixtures/api/account_properties.yml", "test/fixtures/api/account_properties_not_found.yml", "test/fixtures/api/accounts_from_domain.yml", "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/delete_rule.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/update_account_properties.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.licenses = ["GPL-3"]
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.25"
   s.summary = "A MxHero API client for ruby"
-  s.test_files = ["test/fixtures/api/accounts_from_domain.yml", "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/delete_rule.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/update_rule.yml", "test/helper.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb"]
+  s.test_files = ["test/fixtures/api/account_properties.yml", "test/fixtures/api/account_properties_not_found.yml", "test/fixtures/api/accounts_from_domain.yml", "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/delete_rule.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/update_account_properties.yml", "test/fixtures/api/update_rule.yml", "test/helper.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb"]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/test/fixtures/api/account_properties.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://admin:password@localhost:8080/webapi/api/v1/domains/tesla.com/accounts/test/properties
+    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 "U2VydmVy":
+      - !binary |-
+        QXBhY2hlLUNveW90ZS8xLjE=
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "RGF0ZQ==":
+      - !binary |-
+        RnJpLCAwOSBBdWcgMjAxMyAxNjoyMjo1MCBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ! '[{"name":"email","value":"test@tesla.com"},{"name":"fax","value":""},{"name":"lastname","value":"The
+        user test lastname"},{"name":"mobile","value":""},{"name":"name","value":"The
+        user test name"},{"name":"opt1","value":""},{"name":"opt2","value":"option
+        2"},{"name":"opt3","value":""},{"name":"telephone","value":"3333-3333"}]'
+    http_version: 
+  recorded_at: Wed, 14 Aug 2013 18:23:18 GMT
+recorded_with: VCR 2.5.0

data/test/fixtures/api/account_properties_not_found.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://admin:password@localhost:8080/webapi/api/v1/domains/tesla.com/accounts/xxxxx/properties
+    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 "U2VydmVy":
+      - !binary |-
+        QXBhY2hlLUNveW90ZS8xLjE=
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "RGF0ZQ==":
+      - !binary |-
+        RnJpLCAwOSBBdWcgMjAxMyAxNjo0NzoxMyBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ! '{"status":404,"code":404,"message":"domain.account.not.found","developerMessage":"domain.account.not.found","moreInfoUrl":"mailto:support@mxhero.com"}'
+    http_version: 
+  recorded_at: Wed, 14 Aug 2013 18:47:40 GMT
+recorded_with: VCR 2.5.0

data/test/fixtures/api/update_account_properties.yml

@@ -0,0 +1,115 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://admin:password@localhost:8080/webapi/api/v1/domains/tesla.com/accounts/test/properties
+    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 "U2VydmVy":
+      - !binary |-
+        QXBhY2hlLUNveW90ZS8xLjE=
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "RGF0ZQ==":
+      - !binary |-
+        RnJpLCAwOSBBdWcgMjAxMyAxNzozNTo1MCBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ! '[{"name":"email","value":"test@tesla.com"},{"name":"fax","value":""},{"name":"lastname","value":"The
+        user test lastname"},{"name":"mobile","value":""},{"name":"name","value":"The
+        user test name"},{"name":"opt1","value":""},{"name":"opt2","value":"option
+        2"},{"name":"opt3","value":""},{"name":"telephone","value":"3333-3333"}]'
+    http_version: 
+  recorded_at: Wed, 14 Aug 2013 19:36:16 GMT
+- request:
+    method: put
+    uri: http://admin:password@localhost:8080/webapi/api/v1/domains/tesla.com/accounts/test/properties
+    body:
+      encoding: UTF-8
+      string: ! '[{"name":"email","value":"test@tesla.com"},{"name":"fax","value":null},{"name":"lastname","value":"The
+        user test lastname CHANGED"},{"name":"name","value":"The user test name CHANGED"},{"name":"opt1","value":""},{"name":"opt2","value":"option
+        2"},{"name":"opt3","value":""},{"name":"telephone","value":"3333-3333"}]'
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic YWRtaW46cGFzc3dvcmQ=
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0s=
+    headers:
+      !binary "U2VydmVy":
+      - !binary |-
+        QXBhY2hlLUNveW90ZS8xLjE=
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        MA==
+      !binary "RGF0ZQ==":
+      - !binary |-
+        RnJpLCAwOSBBdWcgMjAxMyAxNzozNTo1MCBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Wed, 14 Aug 2013 19:36:16 GMT
+- request:
+    method: get
+    uri: http://admin:password@localhost:8080/webapi/api/v1/domains/tesla.com/accounts/test/properties
+    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 "U2VydmVy":
+      - !binary |-
+        QXBhY2hlLUNveW90ZS8xLjE=
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "RGF0ZQ==":
+      - !binary |-
+        RnJpLCAwOSBBdWcgMjAxMyAxNzozNTo1MCBHTVQ=
+    body:
+      encoding: US-ASCII
+      string: ! '[{"name":"email","value":"test@tesla.com"},{"name":"fax","value":null},{"name":"lastname","value":"The
+        user test lastname CHANGED"},{"name":"name","value":"The user test name CHANGED"},{"name":"opt1","value":""},{"name":"opt2","value":"option
+        2"},{"name":"opt3","value":""},{"name":"telephone","value":"3333-3333"}]'
+    http_version: 
+  recorded_at: Wed, 14 Aug 2013 19:36:16 GMT
+recorded_with: VCR 2.5.0

data/test/test_mxhero_api.rb

@@ -129,6 +129,50 @@ class MxHeroAPITest < MiniTest::Unit::TestCase
     end
   end
 
+  def test_account_properties
+    VCR.use_cassette('account_properties') do 
+      account = 'test'
+      response = @api.account_properties(domain, account)
+      assert_equal 200, response.code
+      assert response.is_a? MxHero::API::Response
+      properties = response.msg
+      %w( email fax lastname mobile name opt1 opt2 opt3 telephone ).each do |property| 
+        assert properties.key? property
+      end
+    end
+  end
+
+  def test_account_propertes_not_found
+    VCR.use_cassette('account_properties_not_found') do 
+      begin
+        account = 'xxxxx'
+        response = @api.account_properties(domain, account)
+        assert_equal 404, response.code
+        assert response.is_a? MxHero::API::Response
+      rescue
+        flunk 'error!'
+      end
+    end
+  end
+
+  def test_update_account_properties
+    VCR.use_cassette('update_account_properties') do 
+      account = 'test'
+      response = @api.account_properties(domain, account)
+      properties = response.msg
+      properties['lastname'] = properties['lastname'] + ' CHANGED' 
+      properties['name']     = properties['name'] + ' CHANGED' 
+      properties['fax']      = nil
+      response = @api.update_account_properties(domain, account, properties)
+      assert_equal 200, response.code
+
+      response = @api.account_properties(domain, account)
+      assert_equal properties['lastname'], response.msg['lastname']
+      assert_equal properties['name'], response.msg['name']
+      assert_equal properties['fax'], response.msg['fax']
+    end
+  end
+
   private
 
   def obtain_rules(domain)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mxhero-api
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-13 00:00:00.000000000 Z
+date: 2013-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
@@ -79,6 +79,8 @@ files:
 - VERSION
 - lib/mxhero-api.rb
 - mxhero-api.gemspec
+- test/fixtures/api/account_properties.yml
+- test/fixtures/api/account_properties_not_found.yml
 - test/fixtures/api/accounts_from_domain.yml
 - test/fixtures/api/create_rule_alredy_exist.yml
 - test/fixtures/api/create_rule_for_domain.yml
@@ -89,6 +91,7 @@ files:
 - test/fixtures/api/domain_rule.yml
 - test/fixtures/api/domains.yml
 - test/fixtures/api/rules_for_domain.yml
+- test/fixtures/api/update_account_properties.yml
 - test/fixtures/api/update_rule.yml
 - test/helper.rb
 - test/test_mxhero_api.rb
@@ -108,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1974219660962474472
+      hash: -69256700798046253
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -122,6 +125,8 @@ signing_key:
 specification_version: 3
 summary: A MxHero API client for ruby
 test_files:
+- test/fixtures/api/account_properties.yml
+- test/fixtures/api/account_properties_not_found.yml
 - test/fixtures/api/accounts_from_domain.yml
 - test/fixtures/api/create_rule_alredy_exist.yml
 - test/fixtures/api/create_rule_for_domain.yml
@@ -132,6 +137,7 @@ test_files:
 - test/fixtures/api/domain_rule.yml
 - test/fixtures/api/domains.yml
 - test/fixtures/api/rules_for_domain.yml
+- test/fixtures/api/update_account_properties.yml
 - test/fixtures/api/update_rule.yml
 - test/helper.rb
 - test/test_mxhero_api.rb