mxhero-api 0.1.13 → 0.1.14

data/VERSION

@@ -1 +1 @@
-0.1.13
+0.1.14

data/lib/dto.rb

@@ -0,0 +1,32 @@
+# DTO class allows to create a structure that support
+# export to json and construct with a hash.
+#
+# Example of use:
+#
+#     class User < DTO.new(:first_name, :last_name, :birthday)
+#
+#     end
+#
+# or
+#
+#     User = Class.new(DTO.new :first_name, :last_name, :birthday)
+#
+class DTO < Struct
+
+  def initialize(attrs = {})
+    members.each do |member|
+      send("#{member}=", attrs[member])
+    end
+  end
+  
+  def to_json
+    attrs = {}
+    members.each { |attr| attrs[attr] = send(attr) }
+    attrs.to_json
+  end
+
+  def to_s
+    members.map { |attr| "#{attr}: #{send(attr)}" }.join(", ")
+  end
+
+end

data/lib/mxhero-api.rb

@@ -5,6 +5,7 @@ require 'json'
 require_relative 'communication'
 require_relative 'urls'
 require_relative 'groups'
+require_relative 'dto'
 
 module MxHero::API
   # The class that contains the response information
@@ -28,6 +29,41 @@ module MxHero::API
     alias_method :content=, :msg=
   end
 
+
+  class Account
+    attr_accessor :account, :domain, :created_date, :updated_date, :group, :properties
+    
+    def initialize(props = {})
+      @account = props[:account] 
+      @domain = props[:domain] 
+      @created_date = props[:created_date] || props[:createdDate]
+      @updated_date = props[:updated_date] || props[:updatedDate]
+      @group = props[:group]
+      @properties = props[:properties] || []
+    end
+
+    def to_json
+      { account: account, domain: domain, 
+        createdDate: created_date, 
+        updatedDate: updated_date,
+        group: group,
+        properties: properties }.to_json
+    end
+
+    def to_s
+      """
+      account: #{account}
+      domain: #{domain}
+      updated_date: #{updated_date}
+      created_date: #{created_date}
+      group: #{group}
+      properties: #{properties}
+      """
+    end
+
+  end
+
+
   # A client to interact with mxhero engine API
   class Client
     include Communication
@@ -159,7 +195,7 @@ module MxHero::API
     def accounts_without_group_url(domain, filter_account)
       domain_by_id_url(domain) + "/groups/accounts/available?account=#{filter_account}"  
     end
- 
+
     def verbose?
       @verbose
     end
@@ -258,8 +294,34 @@ module MxHero::API
       parse_response(response)
     end
 
+    #
+    # @param [String] domain
+    # @param [Array<Hash>] accounts. An array of hash with :account and :properties.  The :properties
+    #   contains a Hash with the equivalent of name and value.
+    # @param [String] scope :groups, :properties or :both (default: properties)
+    #
+    def update_accounts(domain, accounts, scope = :properties)
+      scope_param = scope == :both ? 'groups,properties' : scope.to_s
+      #url = "/domains/#{domain}/accounts/upload?scope=#{scope_param}"
+      url = accounts_by_domain_url(domain) + "/upload?scope=#{scope_param}"
+
+      message = []
+      accounts.each do |account|
+        properties = remap_properties(account[:properties])
+        #message << { account: account[:account], properties: properties, group: account[:group], domain: domain }
+        message << { account: account[:account], properties: properties, group: account[:group] }
+      end
+      response = call(:put, url, message.to_json) # accounts to json 
+      parse_response(response)
+    end
+
+    # --------------------------------------------------------------------------------------------------------------------------------
     private
     
+    def remap_properties(properties)
+      return nil if properties.nil?
+      properties.keys.map { |name| { name: name, value: properties[name] } }
+    end
 
     # Complete the URL with the pagination info (:limit and :offset)
     # @param [String] original URL. Ex.: http://www.example.com/api/accounts

data/mxhero-api.gemspec

@@ -2,20 +2,20 @@
 
 Gem::Specification.new do |s|
   s.name = "mxhero-api"
-  s.version = "0.1.13"
+  s.version = "0.1.14"
 
   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-09-18"
+  s.date = "2013-09-30"
   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/communication.rb", "lib/groups.rb", "lib/mxhero-api.rb", "lib/urls.rb", "mxhero-api.gemspec", "test/fixtures/api/account_properties.yml", "test/fixtures/api/account_properties_not_found.yml", "test/fixtures/api/accounts.yml", "test/fixtures/api/accounts_filtered.yml", "test/fixtures/api/accounts_from_domain.yml", "test/fixtures/api/accounts_from_domain_paginated.yml", "test/fixtures/api/accounts_without_group.yml", "test/fixtures/api/add_an_inexistent_account_to_group.yml", "test/fixtures/api/add_and_remove_account.yml", "test/fixtures/api/all_groups.yml", "test/fixtures/api/create_rule_for_domain.yml", "test/fixtures/api/delete_group.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/remove_account_from_group_twice.yml", "test/fixtures/api/remove_inexistente_account_from_group.yml", "test/fixtures/api/rules_for_domain.yml", "test/fixtures/api/rules_for_domain_by_component.yml", "test/fixtures/api/save_group.yml", "test/fixtures/api/update_account_properties.yml", "test/fixtures/api/update_rule.yml", "test/helper.rb", "test/test_groups.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb"]
+  s.files = [".gitignore", ".rvmrc", "Gemfile", "LICENSE.txt", "README.md", "Rakefile", "VERSION", "lib/communication.rb", "lib/dto.rb", "lib/groups.rb", "lib/mxhero-api.rb", "lib/urls.rb", "mxhero-api.gemspec", "test/fixtures/api/account_properties.yml", "test/fixtures/api/account_properties_not_found.yml", "test/fixtures/api/accounts.yml", "test/fixtures/api/accounts_filtered.yml", "test/fixtures/api/accounts_from_domain.yml", "test/fixtures/api/accounts_from_domain_paginated.yml", "test/fixtures/api/accounts_without_group.yml", "test/fixtures/api/add_an_inexistent_account_to_group.yml", "test/fixtures/api/add_and_remove_account.yml", "test/fixtures/api/all_groups.yml", "test/fixtures/api/create_rule_for_domain.yml", "test/fixtures/api/delete_group.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/remove_account_from_group_twice.yml", "test/fixtures/api/remove_inexistente_account_from_group.yml", "test/fixtures/api/rules_for_domain.yml", "test/fixtures/api/rules_for_domain_by_component.yml", "test/fixtures/api/save_group.yml", "test/fixtures/api/update_account_properties.yml", "test/fixtures/api/update_accounts_group_scope.yml", "test/fixtures/api/update_accounts_properties_scope.yml", "test/fixtures/api/update_rule.yml", "test/helper.rb", "test/test_dto.rb", "test/test_groups.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/account_properties.yml", "test/fixtures/api/account_properties_not_found.yml", "test/fixtures/api/accounts.yml", "test/fixtures/api/accounts_filtered.yml", "test/fixtures/api/accounts_from_domain.yml", "test/fixtures/api/accounts_from_domain_paginated.yml", "test/fixtures/api/accounts_without_group.yml", "test/fixtures/api/add_an_inexistent_account_to_group.yml", "test/fixtures/api/add_and_remove_account.yml", "test/fixtures/api/all_groups.yml", "test/fixtures/api/create_rule_for_domain.yml", "test/fixtures/api/delete_group.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/remove_account_from_group_twice.yml", "test/fixtures/api/remove_inexistente_account_from_group.yml", "test/fixtures/api/rules_for_domain.yml", "test/fixtures/api/rules_for_domain_by_component.yml", "test/fixtures/api/save_group.yml", "test/fixtures/api/update_account_properties.yml", "test/fixtures/api/update_rule.yml", "test/helper.rb", "test/test_groups.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.yml", "test/fixtures/api/accounts_filtered.yml", "test/fixtures/api/accounts_from_domain.yml", "test/fixtures/api/accounts_from_domain_paginated.yml", "test/fixtures/api/accounts_without_group.yml", "test/fixtures/api/add_an_inexistent_account_to_group.yml", "test/fixtures/api/add_and_remove_account.yml", "test/fixtures/api/all_groups.yml", "test/fixtures/api/create_rule_for_domain.yml", "test/fixtures/api/delete_group.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/remove_account_from_group_twice.yml", "test/fixtures/api/remove_inexistente_account_from_group.yml", "test/fixtures/api/rules_for_domain.yml", "test/fixtures/api/rules_for_domain_by_component.yml", "test/fixtures/api/save_group.yml", "test/fixtures/api/update_account_properties.yml", "test/fixtures/api/update_accounts_group_scope.yml", "test/fixtures/api/update_accounts_properties_scope.yml", "test/fixtures/api/update_rule.yml", "test/helper.rb", "test/test_dto.rb", "test/test_groups.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/update_accounts_group_scope.yml

@@ -0,0 +1,75 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: http://admin:password@test.mxhero.com/webapi/api/v1/domains/tesla.com/accounts/upload?scope=groups
+    body:
+      encoding: UTF-8
+      string: ! '[{"account":"john.doe","properties":null,"group":"development"}]'
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic YWRtaW46cGFzc3dvcmQ=
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0s=
+    headers:
+      !binary "RGF0ZQ==":
+      - !binary |-
+        TW9uLCAzMCBTZXAgMjAxMyAxNDoxMDoyMyBHTVQ=
+      !binary "U2VydmVy":
+      - !binary |-
+        QXBhY2hlLzIuMi4xNCAoVWJ1bnR1KQ==
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+    body:
+      encoding: US-ASCII
+      string: ! '[{"account":"john.doe","domain":null,"createdDate":null,"updatedDate":null,"group":"development","aliases":null,"dataSource":null,"properties":null}]'
+    http_version: 
+  recorded_at: Mon, 30 Sep 2013 14:10:23 GMT
+- request:
+    method: get
+    uri: http://admin:password@test.mxhero.com/webapi/api/v1/domains/tesla.com/accounts?account=john.doe&limit=&offset=
+    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 "RGF0ZQ==":
+      - !binary |-
+        TW9uLCAzMCBTZXAgMjAxMyAxNDoxMDoyMyBHTVQ=
+      !binary "U2VydmVy":
+      - !binary |-
+        QXBhY2hlLzIuMi4xNCAoVWJ1bnR1KQ==
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+    body:
+      encoding: US-ASCII
+      string: ! '{"elements":[{"account":"john.doe","domain":"tesla.com","createdDate":1378759081000,"updatedDate":1380550173000,"group":"development","aliases":[{"name":"john.doe","domain":"tesla.com","dataSource":"manual"}],"dataSource":"manual","properties":null}],"totalElements":1,"totalPages":1,"actualPage":1}'
+    http_version: 
+  recorded_at: Mon, 30 Sep 2013 14:10:23 GMT
+recorded_with: VCR 2.5.0

data/test/fixtures/api/update_accounts_properties_scope.yml

@@ -0,0 +1,111 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://admin:password@test.mxhero.com/webapi/api/v1/domains/tesla.com/accounts/john.doe/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 "RGF0ZQ==":
+      - !binary |-
+        RnJpLCAyNyBTZXAgMjAxMyAxOTo1MjozNyBHTVQ=
+      !binary "U2VydmVy":
+      - !binary |-
+        QXBhY2hlLzIuMi4xNCAoVWJ1bnR1KQ==
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+    body:
+      encoding: US-ASCII
+      string: ! '[{"name":"email","value":""},{"name":"fax","value":""},{"name":"lastname","value":""},{"name":"mobile","value":"011212011011"},{"name":"name","value":""},{"name":"opt1","value":""},{"name":"opt2","value":""},{"name":"opt3","value":""},{"name":"telephone","value":""}]'
+    http_version: 
+  recorded_at: Fri, 27 Sep 2013 19:52:37 GMT
+- request:
+    method: put
+    uri: http://admin:password@test.mxhero.com/webapi/api/v1/domains/tesla.com/accounts/upload?scope=properties
+    body:
+      encoding: UTF-8
+      string: ! '[{"account":"john.doe","properties":[{"name":"email","value":""},{"name":"fax","value":""},{"name":"lastname","value":""},{"name":"mobile","value":"011212011011011"},{"name":"name","value":""},{"name":"opt1","value":""},{"name":"opt2","value":""},{"name":"opt3","value":""},{"name":"telephone","value":""}]}]'
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic YWRtaW46cGFzc3dvcmQ=
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0s=
+    headers:
+      !binary "RGF0ZQ==":
+      - !binary |-
+        RnJpLCAyNyBTZXAgMjAxMyAxOTo1MjozOCBHTVQ=
+      !binary "U2VydmVy":
+      - !binary |-
+        QXBhY2hlLzIuMi4xNCAoVWJ1bnR1KQ==
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+    body:
+      encoding: US-ASCII
+      string: ! '[]'
+    http_version: 
+  recorded_at: Fri, 27 Sep 2013 19:52:38 GMT
+- request:
+    method: get
+    uri: http://admin:password@test.mxhero.com/webapi/api/v1/domains/tesla.com/accounts/john.doe/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 "RGF0ZQ==":
+      - !binary |-
+        RnJpLCAyNyBTZXAgMjAxMyAxOTo1MjozOCBHTVQ=
+      !binary "U2VydmVy":
+      - !binary |-
+        QXBhY2hlLzIuMi4xNCAoVWJ1bnR1KQ==
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+    body:
+      encoding: US-ASCII
+      string: ! '[{"name":"email","value":""},{"name":"fax","value":""},{"name":"lastname","value":""},{"name":"mobile","value":"011212011011011"},{"name":"name","value":""},{"name":"opt1","value":""},{"name":"opt2","value":""},{"name":"opt3","value":""},{"name":"telephone","value":""}]'
+    http_version: 
+  recorded_at: Fri, 27 Sep 2013 19:52:38 GMT
+recorded_with: VCR 2.5.0

data/test/test_dto.rb

@@ -0,0 +1,28 @@
+require_relative 'helper'
+
+class User < DTO.new(:first_name, :last_name)
+end
+
+class DTOTest < MiniTest::Unit::TestCase
+  def setup
+    @user = User.new(first_name: 'John', last_name: 'Doe', another: 'Yeah!')
+  end
+
+  def test_accessors
+    assert_equal 'John', @user.first_name
+    assert_equal 'Doe', @user.last_name
+    refute @user.respond_to? :another
+  end
+
+  def test_to_json
+    assert_equal({ first_name: 'John', last_name: 'Doe' }.to_json, @user.to_json)
+    another = Class.new(DTO.new :first_name, :childs )
+    with_childs = another.new(first_name: 'Jess', childs: [ 'Albert', 'Margo' ])
+    assert_equal({ first_name: 'Jess', childs: ['Albert', 'Margo']}.to_json, with_childs.to_json)
+  end
+
+  def test_to_s
+    expected = "first_name: John, last_name: Doe" 
+    assert_equal expected, @user.to_s
+  end
+end

data/test/test_mxhero_api.rb

@@ -219,6 +219,33 @@ class MxHeroAPITest < MiniTest::Unit::TestCase
       assert_equal properties['fax'], response.msg['fax']
     end
   end
+  
+  def test_update_accounts_group_scope
+    VCR.use_cassette('update_accounts_group_scope') do
+
+      accounts = [ { account: 'john.doe', group: 'development' } ]
+      response = @api.update_accounts(domain, accounts, :groups)
+      account = @api.accounts_by_domain(domain, account: 'john.doe')[:elements].first
+      assert_equal 'development', account[:group]
+    end
+  end
+
+  def test_update_accounts_properties_scope
+    VCR.use_cassette('update_accounts_properties_scope') do
+      props = @api.account_properties(domain, 'john.doe').msg
+      changed = props.clone
+      original = changed['mobile']
+      changed['mobile'] = original + '011'
+
+      accounts = [ { account: 'john.doe', properties: changed } ]
+
+      @api.update_accounts(domain, accounts, :properties)
+
+      properties = @api.account_properties(domain, 'john.doe').msg
+      assert_equal original + '011', properties['mobile']
+    end
+  end
+
 
   private
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mxhero-api
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-18 00:00:00.000000000 Z
+date: 2013-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
@@ -78,6 +78,7 @@ files:
 - Rakefile
 - VERSION
 - lib/communication.rb
+- lib/dto.rb
 - lib/groups.rb
 - lib/mxhero-api.rb
 - lib/urls.rb
@@ -105,8 +106,11 @@ files:
 - test/fixtures/api/rules_for_domain_by_component.yml
 - test/fixtures/api/save_group.yml
 - test/fixtures/api/update_account_properties.yml
+- test/fixtures/api/update_accounts_group_scope.yml
+- test/fixtures/api/update_accounts_properties_scope.yml
 - test/fixtures/api/update_rule.yml
 - test/helper.rb
+- test/test_dto.rb
 - test/test_groups.rb
 - test/test_mxhero_api.rb
 - test/test_mxhero_api_response.rb
@@ -125,7 +129,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4402842636666967598
+      hash: -22379060016314683
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -162,8 +166,11 @@ test_files:
 - test/fixtures/api/rules_for_domain_by_component.yml
 - test/fixtures/api/save_group.yml
 - test/fixtures/api/update_account_properties.yml
+- test/fixtures/api/update_accounts_group_scope.yml
+- test/fixtures/api/update_accounts_properties_scope.yml
 - test/fixtures/api/update_rule.yml
 - test/helper.rb
+- test/test_dto.rb
 - test/test_groups.rb
 - test/test_mxhero_api.rb
 - test/test_mxhero_api_response.rb