mxhero-api 0.1.27 → 0.1.28

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OGMwODUzYjE4OTAzNzhkZjVlYmQ3ZDA1YTM1MWI3NDIyYWZmZDU3Mw==
+    ZDNhNzFjMGM0OTZjN2Q1Y2YxZGNlYzUyNTNjYmJjODAzZDJmNTE3ZQ==
   data.tar.gz: !binary |-
-    ZWIxNjFhNmI2M2UyYzhkYTZhYjJlNzk3MDY2YWQxNGUyMzEwZDEwMg==
+    YTVmZDczZTE3ZjczY2YxY2E4NWFhM2JlNjlhNzIwMjM1Yjk5YTUzMw==
 SHA512:
   metadata.gz: !binary |-
-    N2FkMjM4MGE1ZjI0Y2QxZThkMTA5MDBjZmVhYjQ1Y2EzYWJkYjY2ZmM5OTBm
-    ODcwNTg0MGI1YmJhMTIzZThhMzRmMmUzYjIxMzk4NDRjNjVhNTZmNzAyYmUz
-    MjkwYWM1NDExMTZlMzE4OGExMWU1YmFmNWJmMTIyMGMwMGYxOWI=
+    ZmFjZGEyZDkxOGQ5MTRlMzA2MWRiY2M0MzEyMjlmODlmMGFjNWQxYzAzZTc3
+    MmJiNTE0MGFhOTdiM2FiMmVkYWMxYmMxODkxYzVlY2IxYzgzNTJkMWE3NDlh
+    Njg1YWE4MjIxYTU2NjM2OTZmM2IzNDk0YjYxMzllOTE3MzRlYmY=
   data.tar.gz: !binary |-
-    NjVkZDhkMjBhNjM4ODQzYjU1MGU1ZmZiZDhjM2Q3MTA0ZWNmMmVlMGVhZWMw
-    Yjk1OWNiY2Y2YTcxODQxMWY1OTMyNmUzYzYyZTA3M2M2Y2YyOTRmMTRjNjVm
-    YmY3YmFiYTllOThiYjNlN2YzNjBkNWJiZGI4YTczOWQyMDkzZjU=
+    NzBlZmJlY2NkMWQ0ZDhkNTg4YmVmMmFjZDZhY2MzMzA5ZjM3NDAyODg5MTYz
+    NWVlZjNmZGMwZDA0OGI0ZjY0YzQ1MTVkMGUwZDMxMzc2MGQ0M2JiYjQyNGVm
+    MWNiZTZhMjdmMDRmOTA1NTNmMGYwMzRiYWJmOGIzYzdlYzA2NzU=

data/VERSION

@@ -1 +1 @@
-0.1.27
+0.1.28

data/lib/mxhero-api.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 require 'httpclient'
 require 'json'
+require 'date'
 
 require 'communication'
 require 'urls'
@@ -378,12 +379,55 @@ module MxHero::API
       end
       domains
     end
+
+    # Fetch the user 
+    # @return [MxHero::API::Response | nil]
+    def fetch_user(user)
+      response = call(:get, user_url(user))
+      if response.status == 200
+        return parse_response(response)
+      end
+      nil
+    end
+
+
+    # Create a new user
+    # @param [Hash] user_info 
+    # @option user_info [String] :name
+    # @option user_info [String] :lastName
+    # @option user_info [String] :notifyEmail
+    # @option user_info [String] :userName
+    # @option user_info [String] :locale
+    # @option user_info [String] :password
+    #
+    # @param [Array<String>] domains
+    #
+    def create_user(user_info, *domains)
+      user = {
+        name: "", lastName: "", notifyEmail: "",
+        userName: "", locale: "en_US", password: "1234",
+        authorities: ["ROLE_DOMAIN_ADMIN"], 
+        created: DateTime.now.strftime('%Q'),
+        domains: domains.map { |domain| { domain: domain } }
+      }
+      user.merge!(user_info)
+      response = call(:post, users_url, user.to_json, throw_exception: false)
+      response.status == 201
+    end
     
     # --------------------------------------------------------------------------------------------------------------------------------
     private
+
+    def users_url
+      service_url + "/users"
+    end
+
+    def user_url(user)
+      users_url + "/#{user}/"
+    end
    
     def user_domains_url(user)
-      service_url + "/users/#{user}/domains"
+      user_url(user) + "domains"
     end
 
     # Fetch an element from an URL. That element maybe not found

data/mxhero-api.gemspec

@@ -1,22 +1,22 @@
 # -*- encoding: utf-8 -*-
-# stub: mxhero-api 0.1.27 ruby lib
+# stub: mxhero-api 0.1.28 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "mxhero-api"
-  s.version = "0.1.27"
+  s.version = "0.1.28"
 
   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 = "2014-01-13"
+  s.date = "2014-01-20"
   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/directories.rb", "lib/dto.rb", "lib/groups.rb", "lib/mxhero-api.rb", "lib/resource.rb", "lib/resources/account.rb", "lib/resources/domain.rb", "lib/resources/group.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_directory.yml", "test/fixtures/api/create_rule_for_domain.yml", "test/fixtures/api/delete_directory.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/fetch_directory.yml", "test/fixtures/api/ldap_info.yml", "test/fixtures/api/move_to_trial.yml", "test/fixtures/api/refresh_directory.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/system_properties.yml", "test/fixtures/api/system_properties_create.yml", "test/fixtures/api/system_properties_element.yml", "test/fixtures/api/test_domain.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_directory.yml", "test/fixtures/api/update_rule.yml", "test/fixtures/api/user_domains.yml", "test/fixtures/domain.rb", "test/helper.rb", "test/test_directories.rb", "test/test_domain.rb", "test/test_dto.rb", "test/test_feature.rb", "test/test_groups.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb", "test/test_resource.rb"]
+  s.files = [".gitignore", ".rvmrc", "Gemfile", "LICENSE.txt", "README.md", "Rakefile", "VERSION", "lib/communication.rb", "lib/directories.rb", "lib/dto.rb", "lib/groups.rb", "lib/mxhero-api.rb", "lib/resource.rb", "lib/resources/account.rb", "lib/resources/domain.rb", "lib/resources/group.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_directory.yml", "test/fixtures/api/create_rule_for_domain.yml", "test/fixtures/api/create_user.yml", "test/fixtures/api/delete_directory.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/fetch_directory.yml", "test/fixtures/api/fetch_user.yml", "test/fixtures/api/ldap_info.yml", "test/fixtures/api/move_to_trial.yml", "test/fixtures/api/refresh_directory.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/system_properties.yml", "test/fixtures/api/system_properties_create.yml", "test/fixtures/api/system_properties_element.yml", "test/fixtures/api/test_domain.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_directory.yml", "test/fixtures/api/update_rule.yml", "test/fixtures/api/user_domains.yml", "test/fixtures/domain.rb", "test/helper.rb", "test/test_directories.rb", "test/test_domain.rb", "test/test_dto.rb", "test/test_feature.rb", "test/test_groups.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb", "test/test_resource.rb"]
   s.homepage = "http://github.com/mxhero/mxhero-api"
   s.licenses = ["GPL-3"]
   s.require_paths = ["lib"]
   s.rubygems_version = "2.1.9"
   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_directory.yml", "test/fixtures/api/create_rule_for_domain.yml", "test/fixtures/api/delete_directory.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/fetch_directory.yml", "test/fixtures/api/ldap_info.yml", "test/fixtures/api/move_to_trial.yml", "test/fixtures/api/refresh_directory.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/system_properties.yml", "test/fixtures/api/system_properties_create.yml", "test/fixtures/api/system_properties_element.yml", "test/fixtures/api/test_domain.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_directory.yml", "test/fixtures/api/update_rule.yml", "test/fixtures/api/user_domains.yml", "test/fixtures/domain.rb", "test/helper.rb", "test/test_directories.rb", "test/test_domain.rb", "test/test_dto.rb", "test/test_feature.rb", "test/test_groups.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb", "test/test_resource.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_directory.yml", "test/fixtures/api/create_rule_for_domain.yml", "test/fixtures/api/create_user.yml", "test/fixtures/api/delete_directory.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/fetch_directory.yml", "test/fixtures/api/fetch_user.yml", "test/fixtures/api/ldap_info.yml", "test/fixtures/api/move_to_trial.yml", "test/fixtures/api/refresh_directory.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/system_properties.yml", "test/fixtures/api/system_properties_create.yml", "test/fixtures/api/system_properties_element.yml", "test/fixtures/api/test_domain.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_directory.yml", "test/fixtures/api/update_rule.yml", "test/fixtures/api/user_domains.yml", "test/fixtures/domain.rb", "test/helper.rb", "test/test_directories.rb", "test/test_domain.rb", "test/test_dto.rb", "test/test_feature.rb", "test/test_groups.rb", "test/test_mxhero_api.rb", "test/test_mxhero_api_response.rb", "test/test_resource.rb"]
 
   if s.respond_to? :specification_version then
     s.specification_version = 4

data/test/fixtures/api/create_user.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://admin:password@test.mxhero.com/webapi/api/v1/users
+    body:
+      encoding: UTF-8
+      string: ! '{"name":"test","lastName":"test last name","notifyEmail":"test@mxhero.com","userName":"test@mxhero.com","locale":"en_US","password":"1234","authorities":["ROLE_DOMAIN_ADMIN"],"created":"1390249453298","domains":[{"domain":"mxhero.com"},{"domain":"stage.mxhero.com"}]}'
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic YWRtaW46cGFzc3dvcmQ=
+  response:
+    status:
+      code: 201
+      message: !binary |-
+        Q3JlYXRlZA==
+    headers:
+      !binary "RGF0ZQ==":
+      - !binary |-
+        TW9uLCAyMCBKYW4gMjAxNCAyMDoyNDoxNCBHTVQ=
+      !binary "U2VydmVy":
+      - !binary |-
+        QXBhY2hlLzIuMi4xNCAoVWJ1bnR1KQ==
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+    body:
+      encoding: US-ASCII
+      string: ! '{"name":"test","lastName":"test last name","notifyEmail":"test@mxhero.com","userName":"test@mxhero.com","created":1390249453000,"locale":"en_US","password":null,"enabled":true,"authorities":["ROLE_DOMAIN_ADMIN"],"domains":[{"domain":"mxhero.com","created":1390249454000,"updated":1390249454000,"metadata":null},{"domain":"stage.mxhero.com","created":1390249454000,"updated":1390249454000,"metadata":null}]}'
+    http_version: 
+  recorded_at: Mon, 20 Jan 2014 20:24:14 GMT
+recorded_with: VCR 2.5.0

data/test/fixtures/api/fetch_user.yml

@@ -0,0 +1,75 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://admin:password@test.mxhero.com/webapi/api/v1/users/mxhero@mxhero.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 "RGF0ZQ==":
+      - !binary |-
+        TW9uLCAyMCBKYW4gMjAxNCAyMDoxNDoyOCBHTVQ=
+      !binary "U2VydmVy":
+      - !binary |-
+        QXBhY2hlLzIuMi4xNCAoVWJ1bnR1KQ==
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+    body:
+      encoding: US-ASCII
+      string: ! '{"name":"mxhero","lastName":"mxhero","notifyEmail":"mxhero@mxhero.com","userName":"mxhero@mxhero.com","created":1388066459000,"locale":"en_US","password":null,"enabled":true,"authorities":["ROLE_ADMIN"],"domains":[{"domain":"mxhero.com","created":1389711875000,"updated":1389711875000,"metadata":null},{"domain":"stage.mxhero.com","created":1389711875000,"updated":1389711875000,"metadata":null}]}'
+    http_version: 
+  recorded_at: Mon, 20 Jan 2014 20:14:28 GMT
+- request:
+    method: get
+    uri: http://admin:password@test.mxhero.com/webapi/api/v1/users/not-exist@mxhero.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 "RGF0ZQ==":
+      - !binary |-
+        TW9uLCAyMCBKYW4gMjAxNCAyMDoxNDoyOCBHTVQ=
+      !binary "U2VydmVy":
+      - !binary |-
+        QXBhY2hlLzIuMi4xNCAoVWJ1bnR1KQ==
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbg==
+    body:
+      encoding: US-ASCII
+      string: ! '{"status":404,"code":404,"message":"user.not.found","developerMessage":"user.not.found","moreInfoUrl":"mailto:support@mxhero.com"}'
+    http_version: 
+  recorded_at: Mon, 20 Jan 2014 20:14:29 GMT
+recorded_with: VCR 2.5.0

data/test/test_mxhero_api.rb

@@ -316,6 +316,28 @@ class MxHeroAPITest < MiniTest::Unit::TestCase
     end
   end
 
+  def test_fetch_user
+    VCR.use_cassette('fetch_user') do
+      user = @api.fetch_user('mxhero@mxhero.com')
+      refute user.nil?
+      
+      user = @api.fetch_user('not-exist@mxhero.com')
+      assert user.nil?
+    end
+  end
+
+  def test_create_user
+    VCR.use_cassette('create_user') do
+      user_info = {
+        name: 'test', lastName: 'test last name', 
+        notifyEmail: 'test@mxhero.com', userName: 'test@mxhero.com'
+      }
+      created = @api.create_user(user_info, 'mxhero.com', 'stage.mxhero.com')
+      assert created
+    end
+  end
+
+
   private
   
   def delete_all_rules

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mxhero-api
 version: !ruby/object:Gem::Version
-  version: 0.1.27
+  version: 0.1.28
 platform: ruby
 authors:
 - Maximiliano Dello Russo
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-13 00:00:00.000000000 Z
+date: 2014-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
@@ -93,6 +93,7 @@ files:
 - test/fixtures/api/all_groups.yml
 - test/fixtures/api/create_directory.yml
 - test/fixtures/api/create_rule_for_domain.yml
+- test/fixtures/api/create_user.yml
 - test/fixtures/api/delete_directory.yml
 - test/fixtures/api/delete_group.yml
 - test/fixtures/api/delete_rule.yml
@@ -101,6 +102,7 @@ files:
 - test/fixtures/api/domain_rule.yml
 - test/fixtures/api/domains.yml
 - test/fixtures/api/fetch_directory.yml
+- test/fixtures/api/fetch_user.yml
 - test/fixtures/api/ldap_info.yml
 - test/fixtures/api/move_to_trial.yml
 - test/fixtures/api/refresh_directory.yml
@@ -166,6 +168,7 @@ test_files:
 - test/fixtures/api/all_groups.yml
 - test/fixtures/api/create_directory.yml
 - test/fixtures/api/create_rule_for_domain.yml
+- test/fixtures/api/create_user.yml
 - test/fixtures/api/delete_directory.yml
 - test/fixtures/api/delete_group.yml
 - test/fixtures/api/delete_rule.yml
@@ -174,6 +177,7 @@ test_files:
 - test/fixtures/api/domain_rule.yml
 - test/fixtures/api/domains.yml
 - test/fixtures/api/fetch_directory.yml
+- test/fixtures/api/fetch_user.yml
 - test/fixtures/api/ldap_info.yml
 - test/fixtures/api/move_to_trial.yml
 - test/fixtures/api/refresh_directory.yml