login_radius 1.0.1 → 2.0.0

data/lib/login_radius/custom_object_api.rb

@@ -0,0 +1,347 @@
+module LoginRadiusRaas
+  module CustomObjectApi
+    #
+    # This API is used to retrieve all of the custom objects by account ID (UID).
+    #
+    # objectId = 'xxxxxxxxxxxx',
+    # accountId = 'xxxxxxxxxxxx'
+    #
+    # return all custom field
+    # {
+    #     "Id": "53e31d61164ff214a0814327",
+    #     "IsActive": true,
+    #     "DateCreated": "2014-08-07T06:32:01.016Z",
+    #     "DateModified": "2014-08-07T09:09:21.08Z",
+    #     "IsDeleted": true,
+    #     "Uid": "676d5049aba24314b8a5c5af1b80c0cb",
+    #     "CustomObject": {
+    #         "Id": "53e30b2c164ff114a044f3f4",
+    #         "IsActive": true,
+    #         "DateCreated": "2014-08-07T05: 14: 20.573Z",
+    #         "DateModified": "2014-08-07T05: 14: 20.573Z",
+    #         "IsDeleted": false,
+    #         "Uid": "81ef41c461aa4a5eacba0a06f10c1481",
+    #         "CustomObject": {
+    #             "Industry": "chemical",
+    #             "website": "http: //localhost23423423",
+    #             "lastname": "",
+    #             "RelationshipStatus": "married",
+    #             "customfield1": {
+    #                 "field1": "1",
+    #                 "field2": "2",
+    #                 "field5": "5",
+    #                 "field6": "6"
+    #             }
+    #         }
+    #     }
+    # }
+    #
+    #
+    def custom_object_get_by_accountid!(objectId, accountId)
+      api_client("raas/v1/user/customObject", {:objectid => objectId,:accountid => accountId});
+    end
+
+    def custom_object_get_by_accountid(objectId, accountId)
+      custom_object_get_by_accountid!(objectId, accountId)
+    rescue LoginRadiusRaas::Exception => e
+      false
+      end
+
+    #
+    # This API is used to retrieve all of the custom objects by an object’s unique ID.
+    #
+    # objectId = 'xxxxxxxxxxxx';
+    # recordId = 'xxxxxxxxxxxx';
+    #
+    # return all custom field
+    # {
+    #     "Id": "53e31d61164ff214a0814327",
+    #     "IsActive": true,
+    #     "DateCreated": "2014-08-07T06:32:01.016Z",
+    #     "DateModified": "2014-08-07T09:09:21.08Z",
+    #     "IsDeleted": true,
+    #     "Uid": "676d5049aba24314b8a5c5af1b80c0cb",
+    #     "CustomObject": {
+    #         "Id": "53e30b2c164ff114a044f3f4",
+    #         "IsActive": true,
+    #         "DateCreated": "2014-08-07T05: 14: 20.573Z",
+    #         "DateModified": "2014-08-07T05: 14: 20.573Z",
+    #         "IsDeleted": false,
+    #         "Uid": "81ef41c461aa4a5eacba0a06f10c1481",
+    #         "CustomObject": {
+    #             "Industry": "chemical",
+    #             "website": "http: //localhost23423423",
+    #             "lastname": "",
+    #             "RelationshipStatus": "married",
+    #             "customfield1": {
+    #                 "field1": "1",
+    #                 "field2": "2",
+    #                 "field5": "5",
+    #                 "field6": "6"
+    #             }
+    #         }
+    #     }
+    # }
+    #
+    #
+
+    def custom_object_get_by_recordid!(objectId, recordId)
+      api_client("raas/v1/user/customObject", {:objectid => objectId,:id => recordId});
+    end
+
+    def custom_object_get_by_recordid(objectId, recordId)
+      custom_object_get_by_recordid!(objectId, recordId)
+    rescue LoginRadiusRaas::Exception => e
+      false
+      end
+
+    #
+    # This API is used to retrieve all of the custom objects via a list of account IDs(UID) separated by , (Max 20).
+    #
+    # objectId = 'xxxxxxxxxxxx';
+    # accountIds = 'xxxxxxxxxxxx,xxxxxxxxxxxx,xxxxxxxxxxxx';
+    #
+    # return all custom field
+    # [{
+    #     "Id": "53e31d61164ff214a0814327",
+    #     "IsActive": true,
+    #     "DateCreated": "2014-08-07T06:32:01.016Z",
+    #     "DateModified": "2014-08-07T09:09:21.08Z",
+    #     "IsDeleted": true,
+    #     "Uid": "676d5049aba24314b8a5c5af1b80c0cb",
+    #     "CustomObject": {
+    #         "Id": "53e30b2c164ff114a044f3f4",
+    #         "IsActive": true,
+    #         "DateCreated": "2014-08-07T05: 14: 20.573Z",
+    #         "DateModified": "2014-08-07T05: 14: 20.573Z",
+    #         "IsDeleted": false,     #
+    #         "Uid": "81ef41c461aa4a5eacba0a06f10c1481",
+    #         "CustomObject": {
+    #             "Industry": "chemical",
+    #             "website": "http: //localhost23423423",
+    #             "lastname": "",     #
+    #             "RelationshipStatus": "married",
+    #             "customfield1": {
+    #                 "field1": "1",
+    #                 "field2": "2",
+    #                 "field5": "5",
+    #                 "field6": "6"
+    #             }
+    #         }
+    #     }
+    # },
+    # {
+    #     "Id": "53e31d61164ff214a0814327",
+    #     "IsActive": true,
+    #     "DateCreated": "2014-08-07T06:32:01.016Z",
+    #     "DateModified": "2014-08-07T09:09:21.08Z",
+    #     "IsDeleted": true,
+    #     "Uid": "676d5049aba24314b8a5c5af1b80c0cb",
+    #     "CustomObject": {
+    #         "Id": "53e30b2c164ff114a044f3f4",
+    #         "IsActive": true,
+    #         "DateCreated": "2014-08-07T05: 14: 20.573Z",
+    #         "DateModified": "2014-08-07T05: 14: 20.573Z",
+    #         "IsDeleted": false,
+    #         "Uid": "81ef41c461aa4a5eacba0a06f10c1481",
+    #         "CustomObject": {
+    #             "Industry": "chemical",
+    #             "website": "http: //localhost23423423",
+    #             "lastname": "",
+    #             "RelationshipStatus": "married",
+    #             "customfield1": {
+    #                 "field1": "1",
+    #                 "field2": "2",
+    #                 "field5": "5",
+    #                 "field6": "6"
+    #             }
+    #         }
+    #     }
+    # }]
+    #
+    #
+    def custom_object_get_by_accountids!(objectId, accountIds)
+      api_client("raas/v1/user/customObject", {:objectid => objectId,:accountids => accountIds});
+    end
+
+    def custom_object_get_by_accountids(objectId, accountIds)
+      custom_object_get_by_accountids!(objectId, accountIds)
+    rescue LoginRadiusRaas::Exception => e
+      false
+      end
+
+    #
+    # This API is used to retrieve all of the custom objects by an object’s unique ID and filtered by a query
+    #
+    # objectId = 'xxxxxxxxxx';
+    # query = "<Expression LogicalOperation='AND'>
+    #              <Field Name='Provider' ComparisonOperator='Equal'>facebook</Field>
+    #              <Expression LogicalOperation='OR'>
+    #                  <Field Name='Gender' ComparisonOperator='Equal'>M</Field>
+    #                  <Field Name='Gender' ComparisonOperator='Equal'>U</Field>
+    #              </Expression>
+    #          </Expression>";
+    # ------------------ OR ------------------
+    # query = "<Field Name='Gender' ComparisonOperator='Equal'>F</Field>";
+    #
+    # nextCursor=>[1]; (optional)
+    # );
+    #
+    # return all custom field
+    # {
+    #     "Id": "53e31d61164ff214a0814327",
+    #     "IsActive": true,
+    #     "DateCreated": "2014-08-07T06:32:01.016Z",
+    #     "DateModified": "2014-08-07T09:09:21.08Z",
+    #     "IsDeleted": true,
+    #     "Uid": "676d5049aba24314b8a5c5af1b80c0cb",
+    #     "CustomObject": {
+    #         "Id": "53e30b2c164ff114a044f3f4",
+    #         "IsActive": true,
+    #         "DateCreated": "2014-08-07T05: 14: 20.573Z",
+    #         "DateModified": "2014-08-07T05: 14: 20.573Z",
+    #         "IsDeleted": false,
+    #         "Uid": "81ef41c461aa4a5eacba0a06f10c1481",
+    #         "CustomObject": {
+    #             "Industry": "chemical",
+    #             "website": "http: //localhost23423423",
+    #             "lastname": "",
+    #             "RelationshipStatus": "married",
+    #             "customfield1": {
+    #                 "field1": "1",
+    #                 "field2": "2",
+    #                 "field5": "5",
+    #                 "field6": "6"
+    #             }
+    #         }
+    #     }
+    # }
+    #
+
+    def custom_object_get_by_query!(objectId, query, nextCursor)
+      api_client("raas/v1/user/customObject", {:objectid => objectId,:q => query,:cursor => nextCursor});
+    end
+
+    def custom_object_get_by_query(objectId, query, nextCursor=1)
+      custom_object_get_by_query!(objectId, query, nextCursor)
+    rescue LoginRadiusRaas::Exception => e
+      false
+      end
+
+    #
+    # This API is used to retrieve all records from a custom object.
+    #
+    # obejctId = 'xxxxxxxxxx';
+    # nextCursor = [1]; (optional)
+    #
+    # return
+    # {
+    #     "Id": "53e31d61164ff214a0814327",
+    #     "IsActive": true,
+    #     "DateCreated": "2014-08-07T06:32:01.016Z",
+    #     "DateModified": "2014-08-07T09:09:21.08Z",
+    #     "IsDeleted": true,
+    #     "Uid": "676d5049aba24314b8a5c5af1b80c0cb",
+    #     "CustomObject": {
+    #         "Id": "53e30b2c164ff114a044f3f4",
+    #         "IsActive": true,
+    #         "DateCreated": "2014-08-07T05: 14: 20.573Z",
+    #         "DateModified": "2014-08-07T05: 14: 20.573Z",
+    #         "IsDeleted": false,
+    #         "Uid": "81ef41c461aa4a5eacba0a06f10c1481",
+    #         "CustomObject": {
+    #             "Industry": "chemical",
+    #             "website": "http: //localhost23423423",
+    #             "lastname": "",
+    #             "RelationshipStatus": "married",
+    #             "customfield1": {
+    #                 "field1": "1",
+    #                 "field2": "2",
+    #                 "field5": "5",
+    #                 "field6": "6"
+    #             }
+    #         }
+    #     }
+    # }
+    #
+
+    def custom_object_get_all_objects!(objectId, nextCursor)
+      api_client("raas/v1/user/customObject", {:objectid => objectId,:cursor => nextCursor});
+    end
+
+    def custom_object_get_all_objects(objectId, nextCursor=1)
+      custom_object_get_all_objects!(objectId, nextCursor)
+    rescue LoginRadiusRaas::Exception => e
+      false
+      end
+
+    #
+    # This API is used to retrieve stats associated with a custom object
+    #
+    # objectId = 'xxxxxxxxxx';
+    #
+    # return
+    # {
+    #     "TotalUsedMemory": 0.01,
+    #     "RemainingMemory": 9.99,
+    #     "TotalRecords": 7
+    # }
+    #
+    #
+
+    def custom_object_get_stats!(objectId)
+      api_client("raas/v1/user/customObject/stats", {:objectid => objectId});
+    end
+
+    def custom_object_get_all_objects(objectId)
+      custom_object_get_all_objects!(objectId)
+    rescue LoginRadiusRaas::Exception => e
+      false
+      end
+
+    #
+    # This API is used to save custom objects, by providing ID of object, to a specified account if the object is not exist it will create a new object.
+    #
+    # objectId = 'xxxxxxxxxx';
+    # accountId = 'xxxxxxxxxx';
+    # param = {
+    #  firstname => 'first name',
+    #  lastname => 'last name',
+    #  gender => 'm',
+    #  birthdate => 'MM-DD-YYYY',
+    #  ....................
+    #  ....................
+    # }
+    #
+    # return { “isPosted” : true }
+    #
+    def custom_object_upsert!(objectId, accountId, param)
+      api_client("raas/v1/user/customObject/upsert", {:objectid => objectId, :accountid => accountId}, param, 'json');
+    end
+
+    def custom_object_upsert(objectId, accountId, param = {})
+      custom_object_upsert!(objectId, accountId, param)
+    rescue LoginRadiusRaas::Exception => e
+      false
+      end
+
+    #
+    # This API is used to block Custom Object.
+    #
+    # objectId = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
+    # accountId = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
+    # action = true/false(boolean)
+    #
+    # return { “isPosted” : true }
+    #
+    def custom_object_set_status!(objectId, accountId, action)
+      api_client("raas/v1/user/customObject/status", {:objectid => objectId, :accountid => accountId}, {:isblock => action});
+    end
+
+    def custom_object_set_status(objectId, accountId, action=true)
+      custom_object_set_status!(objectId, accountId, action)
+    rescue LoginRadiusRaas::Exception => e
+      false
+      end
+  end
+end

data/lib/login_radius/exception.rb

@@ -1,4 +1,4 @@
-module LoginRadius
-  class Exception < Exception
-  end
-end
+module LoginRadiusRaas
+  class Exception < Exception
+  end
+end

data/lib/login_radius/raas_api.rb

@@ -0,0 +1,102 @@
+require 'net/http'
+
+module LoginRadiusRaas
+  class RaasApi
+    include BasicApi
+    include AccountApi
+    include UserApi
+    include CustomObjectApi
+
+    attr_accessor :appkey, :appsecret, :ssl_verify_peer
+
+    RAAS_API_DOMAIN = "https://api.loginradius.com/"
+    RAAS_CDN_ENDPOINT = "https://cdn.loginradius.com/"
+    # Takes a hash of account secret, token, and connection type(net_http or em_http)
+    # and uses it to auth against the LoginRadius API. Then it returns the Account object. The
+    # async key is optional, if set to true, will use Em::HTTP instead of Net::HTTP.
+    #
+    # @param opts [Hash] Must have keys :token, :secret, :async(optional) and :ssl_verify_peer(optional)
+    # @return [LoginRadius::Account]
+    def initialize(opts = {})
+      self.appsecret = opts[:appsecret]
+      self.appkey = opts[:appkey]
+      self.ssl_verify_peer = opts[:ssl_verify_peer]
+      raise LoginRadiusRaas::Exception.new("Invalid appkey") unless guid_valid?(appkey)
+      raise LoginRadiusRaas::Exception.new("Invalid appsecret") unless guid_valid?(appsecret)
+    end
+
+    # Takes a guid and returns whether or not it is valid.
+    #
+    # @param guid [String]
+    # @return [Boolean]
+    def guid_valid?(guid)
+      guid.match(/^\{?[A-Z0-9]{8}-[A-Z0-9]{4}-[A-Z0-9]{4}-[A-Z0-9]{4}-[A-Z0-9]{12}\}?$/i)
+    end
+
+    # Generic GET call function that other submodules can use to hit the API.
+    #
+    # @param url [String] Target URL to fetch data from.
+    # @param params [Hash] Parameters to send
+    # @return data [Hash] Parsed JSON data from the call
+    def api_client(url, getparams = {}, postparams='get', header='x-www-form-urlencoded')
+      url = RAAS_API_DOMAIN + url unless url.match(/^#{RAAS_API_DOMAIN}/) #in case api root is included,
+      url_obj = URI.parse(url)
+      authentication  = {
+        :appkey => appkey,
+        :appsecret => appsecret
+      }
+      params = authentication.merge(getparams)
+      url_obj.query = URI.encode_www_form(params)
+
+      http = Net::HTTP.new(url_obj.host, url_obj.port)
+      http.use_ssl = true
+      if !ssl_verify_peer
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      if postparams == 'get'
+      response = http.get(url_obj.request_uri)
+      else
+        if header == "json"
+        postparamdata = postparams.to_json;
+        else
+        postparamdata = postparams.to_query;
+        end
+        response = http.post(url_obj.request_uri, postparamdata, {'Content-Type' => 'application/'+header })
+      end
+
+      if response.is_a?(Net::HTTPTemporaryRedirect)
+        #for some reason, we always get redirected when calling server first time.
+        #so if we do, we scan body for the redirect url, and the scan returns
+        #an array of arrays. So we grab the array we know has what we need,
+        #and grab the first element.
+        redirect_url_array = response.body.scan(/<a href=\"([^>]+)\">/i)[1]
+        redirect_url = redirect_url_array.first
+        return api_client(redirect_url, getparams, postparams, header)
+      end
+
+      response = response.body
+
+      # For some reason, this API returns true/false instead of JSON responses for certain calls.
+      # We catch this here.
+      return true if response.match(/^true/i)
+      return false if response.match(/^false/i)
+
+      #We rescue this because sometimes the API returns HTML pages(which can't be JSON parsed)
+      #This mostly happens when people use expired tokens. So we go ahead and raise an exception
+      #About it if it gets caught.
+      begin
+        converted_response = JSON.parse(response, :symbolize_names => true)
+        #it's all String keys in CamelCase above, so...
+        # IF we got a hash back, convert it directly, if its an array, convert each item which is a hash
+        # into snake case
+        # converted_response = unconverted_response.is_a?(Hash) ?
+        # Hash.lr_convert_hash_keys(unconverted_response).symbolize_keys! :
+        # unconverted_response.map { |item| Hash.lr_convert_hash_keys(item).symbolize_keys!
+        return converted_response
+      rescue JSON::ParserError => e
+        raise LoginRadiusRaas::Exception.new("A JSON parsing error occurred because the API returned an HTML page instead of JSON. This happens mostly when you're using an expired Token. Specifics: #{e.message}")
+      end
+    end
+  end
+end