App42_RUBY_SDK 0.8.2 → 0.8.3

data/lib/appTab/BillMonth.rb

@@ -0,0 +1,94 @@
+require 'App42Response.rb'
+
+module App42
+  module AppTab
+    #
+    # An enum that contains the months to be mentioned in the Bill.
+    #
+    class BillMonth < App42Response
+      unless (const_defined?(:JANUARY))
+        JANUARY = "JANUARY"
+      end
+      unless (const_defined?(:FEBRURAY))
+        FEBRURAY = "FEBRURAY"
+      end
+      unless (const_defined?(:MARCH))
+        MARCH = "MARCH"
+      end
+      unless (const_defined?(:APRIL))
+        APRIL = "APRIL"
+      end
+      unless (const_defined?(:MAY))
+        MAY = "MAY"
+      end
+      unless (const_defined?(:JUNE))
+        JUNE = "JUNE"
+      end
+      unless (const_defined?(:JULY))
+        JULY = "JULY"
+      end
+      unless (const_defined?(:AUGUST))
+        AUGUST = "AUGUST"
+      end
+      unless (const_defined?(:SEPTEMBER))
+        SEPTEMBER = "SEPTEMBER"
+      end
+      unless (const_defined?(:OCTOBER))
+        OCTOBER = "OCTOBER"
+      end
+      unless (const_defined?(:NOVEMBER))
+        NOVEMBER = "NOVEMBER"
+      end
+      unless (const_defined?(:DECEMBER))
+        DECEMBER = "DECEMBER"
+      end
+
+      #
+      # Sets the value of the BillMonth.
+      #
+      # @param string
+      #      - the string of BillMonth
+      #
+      def enum(string)
+        return BillMonth.const_get(string)
+      end
+
+      #
+      # Returns the value of the BillMonth.
+      #
+      #  @return the value of BillMonth.
+      #
+
+      def isAvailable(string)
+        if(string == "JANUARY")
+          return "JANUARY"
+        elsif(string == "FEBRURARY")
+          return "FEBRURARY"
+        elsif(string == "MARCH")
+          return "MARCH"
+        elsif(string == "APRIL")
+          return "APRIL"
+        elsif(string == "MAY")
+          return "MAY"
+        elsif(string == "JUNE")
+          return "JUNE"
+        elsif(string == "JULY")
+          return "JULY"
+        elsif(string == "AUGUST")
+          return "AUGUST"
+        elsif(string == "SEPTEMBER")
+          return "SEPTEMBER"
+        elsif(string == "OCTOBER")
+          return "OCTOBER"
+        elsif(string == "NOVEMBER")
+          return "NOVEMBER"
+        elsif(string == "DECEMBER")
+          return "DECEMBER";
+        else
+          return nil
+        end
+      end
+
+    end
+  end
+end

data/lib/appTab/BillResponseBuilder.rb

@@ -0,0 +1,242 @@
+require 'json/pure'
+require 'App42ResponseBuilder.rb'
+require 'appTab/Bill.rb'
+require 'appTab/BillMonth.rb'
+
+module App42
+  module AppTab
+    #
+    #
+    # BillResponseBuilder class converts the JSON response retrieved from the
+    # server to the value object i.e Bill
+    #
+    #
+    class BillResponseBuilder < App42ResponseBuilder
+      #
+      # Converts the response in JSON format to the value object i.e Bill
+      #
+      # @param json
+      #      - response in JSON format
+      #
+      # @return Bill object filled with json data
+      #
+      # @throws Exception
+      #
+      def buildResponse(json)
+        billsJsonObj = getServiceJSONObject("bills", json);
+        billJsonObj = billsJsonObj.fetch("bill");
+        bill = buildBillObject(billJsonObj);
+        bill.strResponse = json
+        bill.isResponseSuccess = isResponseSuccess(json)
+        return bill
+      end
+
+      #
+      # Converts the Bill JSON object to the value object i.e Bill
+      #
+      # @param billJSONObj
+      #      - Bill data as JSONObject
+      #
+      # @return Bill object filled with json data
+      #
+
+      def buildBillObject(billJSONObj)
+        bill = Bill.new
+        buildObjectFromJSONTree(bill, billJSONObj)
+
+        if billJSONObj.key?("storageTransaction")
+          storageTransJson = billJSONObj["storageTransaction"]
+          storageTrans = StorageTransaction.new()
+          transactionList = Array.new
+          storageTrans.transactionList=(transactionList)
+          buildObjectFromJSONTree(storageTrans, storageTransJson)
+
+          if storageTransJson.key?("transactions") && storageTransJson["transactions"].key?("transaction")
+
+            if storageTransJson["transactions"].fetch("transaction").instance_of?(Hash)
+              transactionJsonObj = storageTransJson.fetch("transactions").fetch("transaction");
+              transaction =  App42::AppTab::TransactionStor.new(storageTrans)
+              buildObjectFromJSONTree(transaction, transactionJsonObj)
+
+            else
+
+              transactionJsonArray = storageTransJson.fetch("transactions").fetch("transaction");
+
+              transactionJsonArray.length.times do |i|
+                transactionJsonObj = userJSONArray[i]
+                transaction =  App42::AppTab::TransactionStor.new(storageTrans)
+                buildObjectFromJSONTree(transaction, transactionJsonObj);
+              end
+            end
+          end
+        end
+
+        if billJSONObj.key?("timeTransaction")
+          storageTransJson  = billJSONObj.fetch("timeTransaction");
+          timeTrans = TimeTransaction.new()
+          transactionList = Array.new
+          timeTrans.transactionList=(transactionList)
+          buildObjectFromJSONTree(timeTrans,storageTransJson);
+
+          if storageTransJson.key?("transactions") && storageTransJson.fetch("transactions").key?("transaction")
+
+            if storageTransJson.fetch("transactions").fetch("transaction").instance_of?(Hash)
+              transactionJsonObj = storageTransJson.fetch("transactions").fetch("transaction");
+              transaction = App42::AppTab::TransactionTim.new(timeTrans)
+              buildObjectFromJSONTree(transaction, transactionJsonObj);
+
+            else
+
+              transactionJsonArray = storageTransJson.fetch("transactions").fetch("transaction");
+
+              transactionJsonArray.length.times do |i|
+                transactionJsonObj = transactionJsonArray.fetch(i);
+                transaction = App42::AppTab::TransactionTim.new(timeTrans)
+                buildObjectFromJSONTree(transaction, transactionJsonObj);
+              end
+            end
+          end
+        end
+
+        if billJSONObj.key?("bandWidthTransaction")
+          storageTransJson = billJSONObj.fetch("bandWidthTransaction");
+          bwTrans = BandwidthTransaction.new()
+          transactionList = Array.new
+          bwTrans.transactionList=(transactionList)
+          buildObjectFromJSONTree(bwTrans,storageTransJson);
+
+          if storageTransJson.key?("transactions") && storageTransJson.fetch("transactions").key?("transaction")
+
+            if storageTransJson.fetch("transactions").fetch("transaction").instance_of?(Hash)
+
+              transactionJsonObj = storageTransJson.fetch("transactions").fetch("transaction");
+              transaction =  App42::AppTab::TransactionBand.new(bwTrans)
+              buildObjectFromJSONTree(transaction, transactionJsonObj);
+
+            else
+
+              transactionJsonArray = storageTransJson.fetch("transactions").fetch("transaction");
+
+              transactionJsonArray.length.times do |i|
+                transactionJsonObj = transactionJsonArray.fetch(i);
+                transaction =  App42::AppTab::TransactionBand.new(bwTrans)
+                buildObjectFromJSONTree(transaction, transactionJsonObj);
+              end
+            end
+          end
+        end
+
+        if billJSONObj.key?("levelTransaction")
+          storageTransJson  = billJSONObj.fetch("levelTransaction");
+          levelTrans = LevelTransaction.new()
+          transactionList = Array.new
+          levelTrans.transactionList=(transactionList)
+          buildObjectFromJSONTree(levelTrans, storageTransJson);
+
+          if storageTransJson.key?("transactions") && storageTransJson.fetch("transactions").key?("transaction")
+
+            if storageTransJson.fetch("transactions").fetch("transaction").instance_of?(Hash)
+              transactionJsonObj = storageTransJson.fetch("transactions").fetch("transaction");
+              transaction =  App42::AppTab::TransactionLev.new(levelTrans)
+              buildObjectFromJSONTree(transaction, transactionJsonObj);
+            else
+
+              transactionJsonArray = storageTransJson.fetch("transactions").fetch("transaction");
+              transactionJsonArray.length.times do |i|
+                transactionJsonObj = transactionJsonArray.fetch(i);
+                transaction =  App42::AppTab::TransactionLev.new(levelTrans)
+                buildObjectFromJSONTree(transaction, transactionJsonObj);
+              end
+            end
+          end
+        end
+
+        if billJSONObj.key?("featureTransaction")
+          storageTransJson  = billJSONObj.fetch("featureTransaction");
+          featureTrans = FeatureTransaction.new()
+          transactionList = Array.new
+          featureTrans.transactionList=(transactionList)
+          buildObjectFromJSONTree(featureTrans,storageTransJson);
+
+          if storageTransJson.key?("transactions") && storageTransJson.fetch("transactions").key?("transaction")
+
+            if storageTransJson.fetch("transactions").fetch("transaction").instance_of?(Hash)
+              transactionJsonObj = storageTransJson.fetch("transactions").fetch("transaction");
+              transaction = App42::AppTab::TransactionFeat.new(featureTrans)
+              buildObjectFromJSONTree(transaction, transactionJsonObj);
+
+            else
+
+              transactionJsonArray = storageTransJson.fetch("transactions").fetch("transaction");
+
+              transactionJsonArray.length.times do |i|
+                transactionJsonObj = transactionJsonArray.fetch(i);
+                transaction = App42::AppTab::TransactionFeat.new(featureTrans)
+                buildObjectFromJSONTree(transaction, transactionJsonObj);
+              end
+            end
+          end
+        end
+
+        if billJSONObj.key?("licenseTransaction")
+          storageTransJson  = billJSONObj.fetch("licenseTransaction");
+          licenseTrans = LicenseTransaction.new()
+          transactionList = Array.new
+          licenseTrans.transactionList=(transactionList)
+          buildObjectFromJSONTree(licenseTrans, storageTransJson);
+
+          if storageTransJson.key?("transactions") && storageTransJson.fetch("transactions").key?("transaction")
+
+            if storageTransJson.fetch("transactions").fetch("transaction").instance_of?(Hash)
+
+              transactionJsonObj = storageTransJson.fetch("transactions").fetch("transaction");
+              transaction = App42::AppTab::TransactionLic.new(licenseTrans)
+              buildObjectFromJSONTree(transaction, transactionJsonObj);
+
+            else
+
+              transactionJsonArray = storageTransJson.fetch("transactions").fetch("transaction");
+
+              transactionJsonArray.length.times do |i|
+                transactionJsonObj = transactionJsonArray.fetch(i);
+                transaction = App42::AppTab::TransactionLic.new(licenseTrans)
+                buildObjectFromJSONTree(transaction, transactionJsonObj);
+              end
+            end
+          end
+        end
+
+        return bill;
+      end
+
+      #
+      # Converts the response in JSON format to the list of value objects i.e
+      # Bill
+      #
+      # @param json
+      #      - response in JSON format
+      #
+      # @return List of Bill object filled with json data
+      #
+      #
+
+      def buildArrayResponse(json)
+        billsJSONObj = getServiceJSONObject("bill", json);
+        billJSONArray = billsJSONObj["bill"]
+        billList = Array.new()
+
+        billJSONArray.length.times do |i|
+          billJSONObject = billJSONArray[i]
+          bill = buildBillObject(billJSONObject);
+          bill.strResponse=json
+          bill.isResponseSuccess = isResponseSuccess(json)
+          billList.push(bill)
+        end
+
+        return billList
+      end
+
+    end
+  end
+end
+

data/lib/appTab/BillService.rb

@@ -0,0 +1,457 @@
+require 'connection/RESTConnection.rb'
+require 'util/util.rb'
+require 'json/pure'
+require 'rubygems'
+require 'App42Response.rb'
+require 'appTab/BillResponseBuilder.rb'
+require 'appTab/Bill.rb'
+require 'appTab/BillMonth.rb'
+
+module App42
+  module AppTab
+    #
+    # AppTab - Billing service. This service is used along with the Usage service. It generates
+    # Bill for a particular based on Usage Scheme. For e.g. if user sid's bill has to be seen
+    # for May and 2012. This service will list all the charging transactions and calculate the bill for May
+    # and tell the total usage and price. The calculation is done based on the Price which is given during
+    # scheme creation, the unit of charging and corresponding usage.
+    # AppTab currently just maintains the data and does calculation. How the Bill is rendered and the interface
+    # with Payment Gateway is left with the App developer.
+    #
+    # @see Usage
+    # @see Bill
+    #
+    class BillService
+      #
+      # this is a constructor that takes
+      #
+      # @param apiKey
+      # @param secretKey
+      # @param baseURL
+      #
+      def initialize(api_key, secret_key, base_url)
+        puts "BillService->initialize"
+        @api_key = api_key
+        @secret_key = secret_key
+        @base_url = base_url
+        @resource = "bill"
+        @version = "1.0"
+      end
+
+      #
+      # Get usage for Scheme based on Month and Year. This is useful to show the
+      # user the charging details of the User for the Scheme
+      #
+      # @param userName
+      #      - The user for which the charging information has to be
+      #         fetched
+      # @param usageName
+      #      - The name of the Scheme
+      # @param billMonth
+      #      - The month name for which the usage has to be fetched e.g.
+      #         BillMonth.JANUARY, BillMonth.DECEMBER
+      # @param year
+      #      - The year for which the usage has to be fetched e.g. 2012,
+      #       2011
+      #
+      # @returns All the charging transactions with the total usage and total
+      # price for that month
+      #
+      # @throws App42Exception
+      #
+
+      def usage_time_by_month_and_year(userName, usageName, billMonth, year)
+        puts "usageTimeByMonthAndYear Called "
+        puts "Base url #{@base_url}"
+        response = nil;
+        billObj = nil;
+        billObj = Bill.new
+        util = Util.new
+        util.throwExceptionIfNullOrBlank(userName, "UserName");
+        util.throwExceptionIfNullOrBlank(usageName, "UsageName");
+        util.throwExceptionIfNullOrBlank(billMonth, "billMonth");
+        util.throwExceptionIfNullOrBlank(year, "Year");
+        begin
+          connection = App42::Connection::RESTConnection.new(@base_url)
+          query_params = Hash.new
+          params = {
+            'apiKey'=> @api_key,
+            'version' => @version,
+            'timeStamp' => util.get_timestamp_utc,
+          }
+          query_params = params.clone
+          bm = BillMonth.new()
+          params.store("usageName", usageName);
+          params.store("year", "" + (year.to_i).to_s);
+          params.store("month", bm.enum(billMonth));
+          params.store("userName", userName);
+          signature = util.sign(@secret_key, params)
+          resource_url = "#{@version}/#{@resource}/time/#{usageName}/#{(year.to_i).to_s}/#{billMonth}/#{userName}"
+          response = connection.get(signature, resource_url, query_params)
+          billObj = BillResponseBuilder.new().buildResponse(response)
+        rescue  App42Exception =>e
+          raise e
+        rescue  Exception => e
+          raise App42Exception.new(e)
+        end
+        return billObj
+      end
+
+      #
+      # Get usage for Scheme based on Month and Year. This is useful to show the
+      # user the charging details of the User for the Scheme
+      #
+      # @param userName
+      #      - The user for which the charging information has to be
+      #         fetched
+      # @param usageName
+      #      - The name of the Scheme
+      # @param billMonth
+      #      - The month name for which the usage has to be fetched e.g.
+      #       BillMonth.JANUARY, BillMonth.DECEMBER
+      # @param year
+      #      - The year for which the usage has to be fetched e.g. 2012,
+      #       2011
+      #
+      # @returns All the charging transactions with the total usage and total
+      # price for that month
+      #
+      # @throws App42Exception
+      #
+
+      def usage_storage_by_month_and_year(userName, usageName, billMonth, year)
+        puts "usageStorageByMonthAndYear Called "
+        puts "Base url #{@base_url}"
+        response = nil;
+        billObj = nil;
+        billObj = Bill.new
+        util = Util.new
+        util.throwExceptionIfNullOrBlank(userName, "UserName");
+        util.throwExceptionIfNullOrBlank(usageName, "UsageName");
+        util.throwExceptionIfNullOrBlank(billMonth, "billMonth");
+        util.throwExceptionIfNullOrBlank(year, "Year");
+        begin
+          connection = App42::Connection::RESTConnection.new(@base_url)
+          query_params = Hash.new
+          params = {
+            'apiKey'=> @api_key,
+            'version' => @version,
+            'timeStamp' => util.get_timestamp_utc,
+          }
+          query_params = params.clone
+          bm = BillMonth.new()
+          params.store("usageName", usageName);
+          params.store("year", "" + (year.to_i).to_s);
+          params.store("month", bm.enum(billMonth));
+          params.store("userName", userName);
+          signature = util.sign(@secret_key, params)
+          resource_url = "#{@version}/#{@resource}/storage/#{usageName}/#{(year.to_i).to_s}/#{billMonth}/#{userName}"
+          response = connection.get(signature, resource_url, query_params)
+          billObj = BillResponseBuilder.new().buildResponse(response)
+        rescue  App42Exception =>e
+          raise e
+        rescue  Exception => e
+          raise App42Exception.new(e)
+        end
+        return billObj
+      end
+
+      #
+      # Get usage for Scheme based on Month and Year. This is useful to show the
+      # user the charging details of the User for the Scheme
+      #
+      # @param userName
+      #      - The user for which the charging information has to be
+      #       fetched
+      # @param usageName
+      #      - The name of the Scheme
+      # @param billMonth
+      #      - The month name for which the usage has to be fetched e.g.
+      #       BillMonth.JANUARY, BillMonth.DECEMBER
+      # @param year
+      #      - The year for which the usage has to be fetched e.g. 2012,
+      #       2011
+      #
+      # @returns All the charging transactions with the total usage and total
+      # price for that month
+      #
+      # @throws App42Exception
+      #
+
+      def usage_bandwidth_by_month_and_year(userName, usageName, billMonth, year)
+        puts "usageBandwidthByMonthAndYear Called "
+        puts "Base url #{@base_url}"
+        response = nil;
+        billObj = nil;
+        billObj = Bill.new
+        util = Util.new
+        util.throwExceptionIfNullOrBlank(userName, "UserName");
+        util.throwExceptionIfNullOrBlank(usageName, "UsageName");
+        util.throwExceptionIfNullOrBlank(billMonth, "billMonth");
+        util.throwExceptionIfNullOrBlank(year, "Year");
+        begin
+          connection = App42::Connection::RESTConnection.new(@base_url)
+          query_params = Hash.new
+          params = {
+            'apiKey'=> @api_key,
+            'version' => @version,
+            'timeStamp' => util.get_timestamp_utc,
+          }
+          query_params = params.clone
+          bm = BillMonth.new()
+          params.store("usageName", usageName);
+          params.store("year", "" + (year.to_i).to_s);
+          params.store("month", bm.enum(billMonth));
+          params.store("userName", userName);
+          signature = util.sign(@secret_key, params)
+          resource_url = "#{@version}/#{@resource}/bandwidth/#{usageName}/#{(year.to_i).to_s}/#{billMonth}/#{userName}"
+          response = connection.get(signature, resource_url, query_params)
+          billObj = BillResponseBuilder.new().buildResponse(response)
+        rescue  App42Exception =>e
+          raise e
+        rescue  Exception => e
+          raise App42Exception.new(e)
+        end
+        return billObj
+      end
+
+      #
+      # Get usage for Scheme based on Month and Year. This is useful to show the
+      # user the charging details of the User for the Scheme
+      #
+      # @param userName
+      #      - The user for which the charging information has to be
+      #        fetched
+      # @param usageName
+      #      - The name of the Scheme
+      # @param billMonth
+      #      - The month name for which the usage has to be fetched e.g.
+      #       BillMonth.JANUARY, BillMonth.DECEMBER
+      # @param year
+      #       - The year for which the usage has to be fetched e.g. 2012,
+      #       2011
+      #
+      # @returns All the charging transactions with the total usage and total
+      # price for that month
+      #
+      #  @throws App42Exception
+      #
+
+      def usage_level_by_month_and_year(userName, usageName, billMonth, year)
+        puts "usageLevelByMonthAndYear Called "
+        puts "Base url #{@base_url}"
+        response = nil;
+        billObj = nil;
+        billObj = Bill.new
+        util = Util.new
+        util.throwExceptionIfNullOrBlank(userName, "UserName");
+        util.throwExceptionIfNullOrBlank(usageName, "UsageName");
+        util.throwExceptionIfNullOrBlank(billMonth, "billMonth");
+        util.throwExceptionIfNullOrBlank(year, "Year");
+        begin
+          connection = App42::Connection::RESTConnection.new(@base_url)
+          query_params = Hash.new
+          params = {
+            'apiKey'=> @api_key,
+            'version' => @version,
+            'timeStamp' => util.get_timestamp_utc,
+          }
+          query_params = params.clone
+          bm = BillMonth.new()
+          params.store("usageName", usageName);
+          params.store("year", "" + (year.to_i).to_s);
+          params.store("month", bm.enum(billMonth));
+          params.store("userName", userName);
+          signature = util.sign(@secret_key, params)
+          resource_url = "#{@version}/#{@resource}/level/#{usageName}/#{(year.to_i).to_s}/#{billMonth}/#{userName}"
+          response = connection.get(signature, resource_url, query_params)
+          billObj = BillResponseBuilder.new().buildResponse(response)
+        rescue  App42Exception =>e
+          raise e
+        rescue  Exception => e
+          raise App42Exception.new(e)
+        end
+        return billObj
+      end
+
+      #
+      # Get usage for Scheme based on Month and Year. This is useful to show the
+      # user the charging details of the User for the Scheme
+      #
+      # @param userName
+      #      - The user for which the charging information has to be
+      #       fetched
+      # @param usageName
+      #      - The name of the Scheme
+      # @param billMonth
+      #      - The month name for which the usage has to be fetched e.g.
+      #       BillMonth.JANUARY, BillMonth.DECEMBER
+      # @param year
+      #      - The year for which the usage has to be fetched e.g. 2012,
+      #       2011
+      #
+      # @returns All the charging transactions with the total usage and total
+      # price for that month
+      #
+      # @throws App42Exception
+      #
+
+      def usage_one_time_by_month_and_year(userName, usageName, billMonth, year)
+        puts "usageOneTimeByMonthAndYear Called "
+        puts "Base url #{@base_url}"
+        response = nil;
+        billObj = nil;
+        billObj = Bill.new
+        util = Util.new
+        util.throwExceptionIfNullOrBlank(userName, "UserName");
+        util.throwExceptionIfNullOrBlank(usageName, "UsageName");
+        util.throwExceptionIfNullOrBlank(billMonth, "billMonth");
+        util.throwExceptionIfNullOrBlank(year, "Year");
+        begin
+          connection = App42::Connection::RESTConnection.new(@base_url)
+          query_params = Hash.new
+          params = {
+            'apiKey'=> @api_key,
+            'version' => @version,
+            'timeStamp' => util.get_timestamp_utc,
+          }
+          query_params = params.clone
+          bm = BillMonth.new()
+          params.store("usageName", usageName);
+          params.store("year", "" + (year.to_i).to_s);
+          params.store("month", bm.enum(billMonth));
+          params.store("userName", userName);
+          signature = util.sign(@secret_key, params)
+          resource_url = "#{@version}/#{@resource}/oneTime/#{usageName}/#{(year.to_i).to_s}/#{billMonth}/#{userName}"
+          response = connection.get(signature, resource_url, query_params)
+          billObj = BillResponseBuilder.new().buildResponse(response)
+        rescue  App42Exception =>e
+          raise e
+        rescue  Exception => e
+          raise App42Exception.new(e)
+        end
+        return billObj
+      end
+
+      #
+      # Get usage for Scheme based on Month and Year. This is useful to show the
+      # user the charging details of the User for the Scheme
+      #
+      # @param userName
+      #      - The user for which the charging information has to be
+      #         fetched
+      # @param usageName
+      #      - The name of the Scheme
+      # @param billMonth
+      #      - The month name for which the usage has to be fetched e.g.
+      #       BillMonth.JANUARY, BillMonth.DECEMBER
+      # @param year
+      #      - The year for which the usage has to be fetched e.g. 2012,
+      #       2011
+      #
+      # @returns All the charging transactions with the total usage and total
+      # price for that month
+      #
+      # @throws App42Exception
+      #
+
+      def usage_feature_by_month_and_year(userName, usageName, billMonth, year)
+        puts "usageFeatureByMonthAndYear Called "
+        puts "Base url #{@base_url}"
+        response = nil;
+        billObj = nil;
+        billObj = Bill.new
+        util = Util.new
+        util.throwExceptionIfNullOrBlank(userName, "UserName");
+        util.throwExceptionIfNullOrBlank(usageName, "UsageName");
+        util.throwExceptionIfNullOrBlank(billMonth, "billMonth");
+        util.throwExceptionIfNullOrBlank(year, "Year");
+        begin
+          connection = App42::Connection::RESTConnection.new(@base_url)
+          query_params = Hash.new
+          params = {
+            'apiKey'=> @api_key,
+            'version' => @version,
+            'timeStamp' => util.get_timestamp_utc,
+          }
+          query_params = params.clone
+          bm = BillMonth.new()
+          params.store("usageName", usageName);
+          params.store("year", "" + (year.to_i).to_s);
+          params.store("month", bm.enum(billMonth));
+          params.store("userName", userName);
+          signature = util.sign(@secret_key, params)
+          resource_url = "#{@version}/#{@resource}/feature/#{usageName}/#{(year.to_i).to_s}/#{billMonth}/#{userName}"
+          response = connection.get(signature, resource_url, query_params)
+          billObj = BillResponseBuilder.new().buildResponse(response)
+        rescue  App42Exception =>e
+          raise e
+        rescue  Exception => e
+          raise App42Exception.new(e)
+        end
+        return billObj
+      end
+
+      #
+      # Get usage for Scheme based on Month and Year. This is useful to show the
+      # user the charging details of the User for the Scheme
+      #
+      # @param userName
+      #      - The user for which the charging information has to be
+      #         fetched
+      # @param licenseName
+      #      - The name of the License
+      # @param billMonth
+      #      - The month name for which the usage has to be fetched e.g.
+      #       BillMonth.JANUARY, BillMonth.DECEMBER
+      # @param year
+      #      - The year for which the usage has to be fetched e.g. 2012,
+      #       2011
+      #
+      # @returns All the charging transactions with the total usage and total
+      # price for that month
+      #
+      # @throws App42Exception
+      #
+      #
+
+      def usage_license_by_month_and_year(userName, licenseName, billMonth, year)
+        puts "usageLicenseByMonthAndYear Called "
+        puts "Base url #{@base_url}"
+        response = nil;
+        billObj = nil;
+        billObj = Bill.new
+        util = Util.new
+        util.throwExceptionIfNullOrBlank(userName, "UserName");
+        util.throwExceptionIfNullOrBlank(licenseName, "LicenseName");
+        util.throwExceptionIfNullOrBlank(billMonth, "billMonth");
+        util.throwExceptionIfNullOrBlank(year, "Year");
+        begin
+          connection = App42::Connection::RESTConnection.new(@base_url)
+          query_params = Hash.new
+          params = {
+            'apiKey'=> @api_key,
+            'version' => @version,
+            'timeStamp' => util.get_timestamp_utc,
+          }
+          query_params = params.clone
+          bm = BillMonth.new()
+          params.store("licenseName", licenseName);
+          params.store("year", "" + (year.to_i).to_s);
+          params.store("month", bm.enum(billMonth));
+          params.store("userName", userName);
+          signature = util.sign(@secret_key, params)
+          resource_url = "#{@version}/#{@resource}/license/#{licenseName}/#{(year.to_i).to_s}/#{billMonth}/#{userName}"
+          response = connection.get(signature, resource_url, query_params)
+          billObj = BillResponseBuilder.new().buildResponse(response)
+        rescue  App42Exception =>e
+          raise e
+        rescue  Exception => e
+          raise App42Exception.new(e)
+        end
+        return billObj
+      end
+
+    end
+  end
+end