AvrijAnalyticsUtility 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42b55c3510396745ec136f294a33fefbc9c41de5
-  data.tar.gz: 4305c3b17c0b1b49901c6034fe8ce0012e4a1d5d
+  metadata.gz: f6360dbe36f72a703e62c4e2dd49609ce7f5fd9a
+  data.tar.gz: 467a95abff98dba3a60e1db4e202097bf6c20aaa
 SHA512:
-  metadata.gz: b755c6ed6106f4ca369d623959af88a5878f44a5d6714601ede1769504c0f478fced71013c0582e5ca2d7286a446239b415ca47007a15f8678cd497102abe15f
-  data.tar.gz: 1cc03dc82d1447af8d280887ee064afd4012c8e4a3e0c845fb6f93d1b6044789f7e6bf778e62ddaa7558f6ca6160d1988e253a088f331cd18a32847596e67d8a
+  metadata.gz: 8db5386a39a4d64e0fd4f29a9f345e2f96c417e1897720b7fa5c1203d585a81e74f16aff5c222e56a2bc2fcfa921e906a864d423c45354fafe1cfc0cb88ced0c
+  data.tar.gz: d45a02fae80ab38a4394e2f3589da13e65d4ca1f8d21c73414cb37ab690bb9b61a9b061e8eec4185d79a9968f2386e3b37ae6733a21a463af7338205db54341b

data/Rakefile

@@ -14,3 +14,4 @@ task :release do
 end
 
 
+

data/lib/AvrijAnalyticsUtility/APIConnection.rb

@@ -8,24 +8,93 @@ class AvrijAnalyticsUtility::APIConnection
   @AUTH_VALUE = nil
   @HEADER_VALUE = nil
   
+  # Returns the social media post
+  #
+  # ==== Attributes
+  #
+  # * +param_api_uri+ - API end point
+  # * +param_query_hash+ - query hash
+  #
+  # ==== Examples
+  #
+  # +parap_api_uri+
+  #
+  # https://www.company.com:8080/api/endPoint
+  #
+  # +param_query_hash+
+  #
+  #    query_values = {
+  #        "key1" => "value1",
+  #        "key2" => "value2" 
+  #    }
+  # 
+  # ==== 
   def getSocialMediaPost(param_api_uri,param_query_hash)    
       @OPTIONS = {query: param_query_hash , headers:@HEADER_VALUE}
-      get_result = HTTParty.get(param_api_uri,@OPTIONS)
-      puts get_result.request.last_uri.to_s
-      return get_result.parsed_response
+      getRequest_result = HTTParty.get(param_api_uri,@OPTIONS)
+      return getRequest_result
   end
   
+  # API Endpoint Request
+  #
+  # ==== Attributes
+  #
+  # * +param_api_endpoint+ - API endpoint
+  # * +param_header_hash+ - Header hash
+  # * +param_query_hash+ - Query hash
+  #
+  # ==== Return
+  #
+  # * returns get request OBJECT
+  #
+  # ====
+  def getAPI_Request(param_api_endpoint,param_header_hash,param_query_hash)
+     @OPTIONS = {headers: param_header_hash, query: param_query_hash}
+     getRequest_result = HTTParty.get(param_api_endpoint,@OPTIONS)
+  end
   
   
+  # Returns all entities
+  # 
+  # ==== Attributes
+  #
+  # * +param_api_uri_+ - API end point
+  #
+  # ==== Return
+  #
+  # * returns get request OBJECT
+  #
+  # ==== Examples
+  #
+  # +parap_api_uri+
+  #
+  # https://www.company.com:8080/api/endPoint
+  #
+  # ==== 
   def getAllEntities(param_api_uri)  
       @OPTIONS = {headers:@HEADER_VALUE}
-      get_result = HTTParty.get(param_api_uri,@OPTIONS)  
-      puts get_result.request.last_uri.to_s
-      return get_result.parsed_response       
+      getRequest_result = HTTParty.get(param_api_uri,@OPTIONS)  
+      return getRequest_result       
   end  
 
+  # Returns Authentication Token
+  def getToken
+    return @AUTH_TOKEN
+  end
   
-#----------- Private Methods --------------  
+  # Authenticate
+  #
+  # ==== Attributes
+  #
+  # * +param_username+ - Username
+  # * +param_password+ - Password
+  # * +param_api_uri+ - API endpoint for authentication
+  #
+  # ==== Return
+  #
+  # * returns TRUE if authentication is successful
+  #
+  # ====
   def authenticate(param_username,param_password,param_api_uri)
       @options = {
           headers: {
@@ -44,12 +113,6 @@ class AvrijAnalyticsUtility::APIConnection
       }
       return !@AUTH_VALUE.nil?     
   end
-
-  def jsonStr_to_jsonFile(param_jsonstring,param_outputfile)
-    File.open(param_outputfile,"w") do |f|
-      f.write(param_jsonstring.to_json)
-    end
-  end
-  
   
+
 end

data/lib/AvrijAnalyticsUtility/version.rb

@@ -1,3 +1,3 @@
 module AvrijAnalyticsUtility
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

data/lib/AvrijAnalyticsUtility.rb

@@ -2,11 +2,27 @@ require "AvrijAnalyticsUtility/version"
 require "AvrijAnalyticsUtility/APIConnection"
 
 module AvrijAnalyticsUtility
-     
-     
-  #GET ALL SOCIAL MEDIA POST   
-  # datetime must have the following format : 2017-06-30T00:00:00+04:00
-  def self.getAllSocialMediaPostfromDateRange(param_username,param_password,param_auth_uri,param_data_uri,param_from_datetime,param_to_datetime,send_to_file)
+  
+  # Get all social media post given from date_1 to date_2
+  # 
+  # ==== Attributes
+  #
+  # * +param_username+ - Username
+  # * +param_password+ - Password
+  # * +param_auth_uri+ - Authentication end point
+  # * +param_data_uri+ - API data source end point
+  # * +param_from_datetime+ - From date value
+  # * +param_to_datetime+ - To date value
+  # 
+  # ==== Return
+  #
+  # * returns GET request OBJECT
+  #
+  # ==== Notes
+  # * datetime must have the following format : 2017-06-30T00:00:00+04:00
+  # 
+  # ====
+  def self.getAllSocialMediaPostfromDateRange(param_username,param_password,param_auth_uri,param_data_uri,param_from_datetime,param_to_datetime)
     query_values = {
           "entity" => "All identified",
           "from" => param_from_datetime,
@@ -22,48 +38,42 @@ module AvrijAnalyticsUtility
     puts query_values
     conn = APIConnection.new
     conn.authenticate(param_username,param_password,param_auth_uri)
-    response = conn.getSocialMediaPost(param_data_uri,query_values)
-    if send_to_file
-      filename = 'AllSocialMediaPost.json'
-      conn.jsonStr_to_jsonFile(response,filename)
-    end 
-    return response
+    get_request_object = conn.getSocialMediaPost(param_data_uri,query_values)
+    return get_request_object
   end  
     
-  #GET SOCIAL MEDIA POST GIVEN THE ENTITY NAME AND DATE  
-  def self.getSocialMediaPost(param_username,param_password,param_auth_uri,param_data_uri,param_entity,param_date,send_to_file)
-    query_values = {
-          "entity"=> param_entity,
-          "from" => param_date,
-          "to" => param_date,
-          "facebook" => "0",
-          "facebookPost" => "0",
-          "reddit"=>"0",
-          "youtube" => "0",
-          "youtubeComment"=>"0",
-          "twitter" => "0",
-          "news" => "0"
-    }
+  # Get all entities
+  # 
+  # ==== Attributes
+  #
+  # * +param_username+ - Username
+  # * +param_password+ - Password
+  # * +param_auth_uri+ - API endpoint for authentication
+  # * +param_data_uri+ - API endpoint for data request
+  # 
+  # ==== Return
+  #
+  # * returns GET request OBJECT
+  #
+  # ====
+  def self.getAllEntities(param_username,param_password,param_auth_uri,param_data_uri)
     conn = APIConnection.new
     conn.authenticate(param_username,param_password,param_auth_uri)
-    response = conn.getSocialMediaPost(param_data_uri,query_values)
-    if send_to_file
-      filename = 'result_' + param_entity + "_" + param_date +".json"
-      conn.jsonStr_to_jsonFile(response,filename)
-    end 
-    return response  
-  end   
-  
-  # GET ENTITIES FROM AN API SOURCE
-  def self.getEntities(param_username,param_password,param_auth_uri,param_data_uri,send_to_file)
-    conn = APIConnection.new
-    conn.authenticate(param_username,param_password,param_auth_uri)
-    response = conn.getAllEntities(param_data_uri)
-    if send_to_file
-      filename = 'result_entities.json'
-      conn.jsonStr_to_jsonFile(response,filename)
-    end 
-    return response  
+    get_request_object = conn.getAllEntities(param_data_uri)
+    return get_request_object  
   end
 
+  # Writes json string to json file
+  #
+  # ==== Attributes
+  #
+  # * +param_jsonstring+ - json string value
+  # * +param_outputfile+ - json file name
+  #
+  # ====
+  def jsonString_to_json(param_jsonstring,param_outputfile)
+    File.open(param_outputfile,"w") do |f|
+      f.write(param_jsonstring.to_json)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: AvrijAnalyticsUtility
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Michael Dalisay