zuora_api 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c55ec215788feb32e23a15d1b184106afede1d1d
-  data.tar.gz: e0735b673b4d2809d9382fadb6072e8c37d89351
+  metadata.gz: d92c60b9da5b74041b862fdd2af9194efaf4d9fd
+  data.tar.gz: 56465882c0f981d112eaa407ddff336a2ac9b2f8
 SHA512:
-  metadata.gz: 02fba7b0de2e9ff2e58bbc247726e6c3b60ce5a483a99d0a0c9aebb36b2e741c33370a1f59bd5e6a33224753a8e990533b45a2812bfe220077789a51a0e62c93
-  data.tar.gz: e893da8fd4cf5f9fb04934f2d8181058b94107adee328bee74e8372f694685c888d8b14e09b0751dc3ed1a5e9fcb5fe5c58d988d4ec60cb0e839deda9facc7cf
+  metadata.gz: aba52fda66bbb00072045a19d1ec30d534c7544e50395afef39c48a0ea1fb146a3939a14bf2bf97dc258542b7a84df008965a35e68e82470f18fd1aeb68ec995
+  data.tar.gz: 99bb1f0be83771d07212c1d7dfd25a3dcd517c01f9b1a06fc5d962415e1ae2be834bd2bdba1d8c8a06e07069e141046243ede52d735c1cbce6670770daaef4f2

data/README.md

@@ -101,7 +101,47 @@ response = zuora_client.describe_call()
 ```
 
 ### Journal Run
-
 ```ruby
 zuora_client.createJournalRun(call)
 ```
+
+## Insights API
+
+In order to make API calls a Zuora Login object must be created by running:
+
+```ruby
+insightsapi = InsightsAPI::Login.new(api_token: "api token", url: "Nw1.api.insights.zuora.com/api/")
+```
+
+Note that the login will default to the insights production url.
+
+```ruby
+Date format: "YYYY-MM-DDT00:00:00Z"
+```
+
+### Uploading Data into Insights
+```ruby
+insightsapi.upload_into_insights(dataSourceName, recordType, batchDate, filePath)
+```
+dataSourceName: What system the data is coming from.
+recordType: The type of records ie: "EVENTS, ATTRIBUTES, and METRICS"
+batachDate: The date the data applies to.
+
+### Describing Insights Data
+```ruby
+insightsapi.describe(type: "ACCOUNT/USER", object: "ATTRIBUTES/EVENTS/SEGMENTS/METRICS")
+```
+Returns json payload describing attributes, events, metrics for each Account or User.
+
+### Downloading Data from Insights
+```ruby
+insightsapi.data_export_insights(objecttype, segmentuuid, startDate: nil, endDate: nil, tries: 30)
+```
+```ruby
+insightsapi.data_export_insights_file(objecttype, segmentuuid, startDate: nil, endDate: nil, tries: 30)
+```
+Both do the same thing except one returns a url(data_export_insights) to download the file yourself and the other returns an actual Ruby temporary file(data_export_insights_file).
+
+objectype: "ACCOUNT/USER"
+
+segmentuuid: A single or array of string or int of a segment uuid(s) that you get from the describe call. The csv holds a column with a bool that represents if that User or Account belongs to that segment.

data/lib/insights_api/login.rb

@@ -0,0 +1,213 @@
+require "httparty"
+require "zip"
+module InsightsAPI
+  class Login
+    attr_accessor :api_token, :url
+
+    def initialize(api_token: nil, url: "Nw1.api.insights.zuora.com/api/", **keyword_args)
+      @api_token = api_token
+      @url = url
+    end
+
+    def insight_getstatus(uuid)
+      response = HTTParty.get(
+              "https://#{@url}/export/status/#{uuid}",
+              :basic_auth => { :username => @api_token })
+      if response.code == 200
+        parsed = JSON.parse(response.body)
+        return parsed
+      #error handing here
+      end
+    end
+
+    def data_export_insights_file(objecttype, segmentuuid, startDate: nil, endDate: nil, tries: 30)
+      status = data_export_insights(objecttype, segmentuuid, startDate, endDate, tries: 30)
+      if status['status']== "COMPLETE"
+        signedUrl = status['signedUrl']
+        return get_file(file_name: "insights-#{startDate}-#{endDate}.csv", url: signedUrl, headers: {}, count: 3, file_type: "zip")
+      else
+        return status
+      end
+    end
+
+    def data_export_insights(objecttype, segmentuuid, startDate: nil, endDate: nil, tries: 30)
+      status = insights_fetch_all(objecttype, segmentuuid, startDate, endDate)
+      if status['uuid'] == nil
+        return "Failed: #{status["response"]}"
+      else
+        fileid = status['uuid']
+      end
+      for retries in 1..tries
+        status = insight_getstatus(fileid)
+        if status['status']== "COMPLETE"
+          signedUrl = status['signedUrl']
+          return status
+        elsif status['status'] == "FAILED"
+          return status
+        else
+          sleep(60)
+          retries+=1
+        end
+        if retries > tries - 1
+          return "Timeout"
+        end
+      end
+      return signedUrl
+    end
+
+    def insights_fetch_all(objecttype, segmentuuid, startDate, endDate)
+      if segmentuuid.is_a? Array
+        segmentsForAPI = segmentuuid.join('","')
+      elsif segmentuuid.is_a? String
+        segmentsForAPI = segmentuuid
+      elsif segmentuuid.is_a? Integer
+        segmentsForAPI = segmentuuid.to_s
+      else
+        raise "Error fetching Insights data: Segmentuuid must be either an array of uuids or an single uuid in string or interger format."
+      end
+
+      response = HTTParty.post(
+              "https://#{@url}/export/type/#{objecttype}",
+              :basic_auth => { :username => @api_token },
+              :headers => {'Content-Type'=> "Application/json"},
+              :body =>
+              '
+              {
+                "endDate": "' + (dateFormat(date: endDate)).to_s + '",
+                "startDate":"' + (dateFormat(date: startDate)).to_s + '",
+                "segments": [
+                  "'+segmentsForAPI+'"
+                ]
+              }
+              ')
+      if response.code == 200
+        parsed = JSON.parse(response.body)
+        return parsed
+      else
+        return {"uuid"=> nil, "status"=>"Error", "signedUrl"=>"signedUrl", "response" => response.body}
+      end
+    end
+
+    def dateFormat(date: nil)
+      date ||= DateTime.now
+      return (date.to_date).to_s
+    end
+
+    def upload_into_insights(dataSourceName, recordType, batchDate, filePath)
+      begin
+        response = HTTParty.post(
+          "https://#{@url}/files/upload",
+          :basic_auth => { :username => @api_token }, :body => {
+          :dataSource => dataSourceName, :recordType => recordType,
+          :batchDate => dateFormat(date: batchDate) + "T00:00:00Z"})
+        parsed = JSON.parse(response.body)
+        signedUrl = parsed['signedUrl']
+        if !File.extname(filePath) == ".gz"
+          zipPath = gzip_file(filePath)
+        else
+          zipPath = filePath
+        end
+
+        gzippedFile = File.open(zipPath)
+        post = HTTParty.put(signedUrl,
+          :body => gzippedFile.read)
+        if post.code == 200
+          return {"status"=>"COMPLETE", "signedUrl"=>"signedUrl", "response" => post.code}
+        else
+          return {"status"=>"Error", "signedUrl"=>"signedUrl", "response" => post.code}
+        end
+      rescue Exception => e
+          Rails.logger.debug "[ZuoraGem]: While uploading to insights Error: #{e}"
+        raise e
+      end
+    end
+
+    def describe(type: "ACCOUNT", object: "attributes")
+      url = "https://#{@url}/export/#{object}/#{type}"
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      begin
+        request = Net::HTTP::Get.new(uri.request_uri)
+
+        request.basic_auth(@api_token, "")
+
+        if request.code == '200'
+          return http.request(request)
+        else
+          return "Failed"
+        end
+      rescue Exception => e
+          Rails.logger.debug "[ZuoraGem]: While describing Zoura Insights objects: #{e}"
+        return "Failed"
+      end
+    end
+
+    def get_file(file_name: nil, url: nil,  basic: {:username => nil, :password => nil}, headers: {}, count: 3, file_type: "zip")
+      tries ||= 2
+      temp_file = nil
+      uri = URI(url)
+      Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+        request = Net::HTTP::Get.new(uri)
+        headers.each do |k,v|
+          request["#{k}"] = v
+        end
+        request.basic_auth(basic[:username], basic[:password]) if (!basic[:username].blank? && !basic[:password].blank?)
+        http.request request do |response|
+          case response
+          when Net::HTTPNotFound
+            Rails.logger.fatal("[ZuoraGem]: 404 - Not Found")
+            raise response
+
+          when Net::HTTPUnauthorized
+            raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(zuora_client.current_error) if count <= 0
+            Rails.logger.fatal("[ZuoraGem]: Retry")
+            zuora_client.new_session
+            return get_file(:url => url, :count => count - 1, :headers => headers)
+
+          when Net::HTTPClientError
+            Rails.logger.debug("[ZuoraGem]: #{response}")
+            raise response
+
+          when Net::HTTPOK
+            Tempfile.open([file_name.rpartition('.').first, ".#{file_name.rpartition('.').last}"], "#{Rails.root}/tmp") do |tmp_file|
+              temp_file ||= tmp_file
+              tmp_file.binmode if (response.to_hash["content-type"].include?("application/zip") || response.to_hash["content-type"] == "application/zip")
+              response.read_body do |chunk|
+                tmp_file.write chunk.force_encoding("UTF-8")
+              end
+            end
+          end
+        end
+      end
+
+      rescue => ex
+        if !(tries -= 1).zero?
+         sleep 3
+         retry
+        else
+         raise ex
+        end
+      else
+        return temp_file
+    end
+
+    def gzip_file(filePath)
+      Zlib::GzipWriter.open(filePath + ".gz") do |gzip|
+         open(filePath, "rb") do |f|
+            f.each_chunk() {|chunk| gzip.write chunk }
+          end
+        gzip.close
+      end
+      return filePath+ ".gz"
+    end
+
+  end
+end
+
+class File
+  def each_chunk(chunk_size=2**16)
+      yield read(chunk_size) until eof?
+  end
+end

data/lib/zuora_api.rb

@@ -2,6 +2,7 @@ require 'rails'
 
 require "zuora_api/login"
 require 'zuora_api/exceptions'
+require "insights_api/login"
 module ZuoraAPI
   # Your code goes here...
 end

data/lib/zuora_api/login.rb

@@ -366,7 +366,7 @@ module ZuoraAPI
     end
 
     def get_catalog
-      products, response = [{}, {'nextPage' => self.rest_endpoint('catalog/products?pageSize=40') }]
+      products, catalog_map, response = [{}, {}, {'nextPage' => self.rest_endpoint('catalog/products?pageSize=40') }]
       while !response["nextPage"].blank?
         url = self.rest_endpoint(response["nextPage"].split('/v1/').last)
         Rails.logger.debug("Fetch Catalog URL #{url}")
@@ -375,12 +375,18 @@ module ZuoraAPI
           raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Error Getting Catalog: #{output_json}")
         end
         output_json["products"].each do |product|
+          catalog_map[product["id"]] = {"productId" => product["id"]}
           rateplans = {}
+
           product["productRatePlans"].each do |rateplan|
+            catalog_map[rateplan["id"]] = {"productId" => product["id"], "productRatePlanId" => rateplan["id"]}
             charges = {}
+
             rateplan["productRatePlanCharges"].each do |charge|
+              catalog_map[charge["id"]] = {"productId" => product["id"], "productRatePlanId" => rateplan["id"], "productRatePlanChargeId" => charge["id"], }
               charges[charge["id"]] = charge.merge({"productId" => product["id"], "productName" => product["name"], "productRatePlanId" => rateplan["id"], "productRatePlanName" => rateplan["name"] })
             end
+
             rateplan["productRatePlanCharges"] = charges
             rateplans[rateplan["id"]] = rateplan.merge({"productId" => product["id"], "productName" => product["name"]})
           end
@@ -388,7 +394,7 @@ module ZuoraAPI
           products[product['id']] = product
         end
       end
-      return products
+      return products, catalog_map
     end
 
     def get_file(file_name: nil, url: nil, headers: {}, count: 3, file_type: "zip")

data/lib/zuora_api/version.rb

@@ -1,3 +1,3 @@
 module ZuoraAPI
-  VERSION = "1.3.2"
+  VERSION = "1.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_api
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors:
 - Zuora Strategic Solutions Group
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-11 00:00:00.000000000 Z
+date: 2017-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -131,6 +131,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/insights_api/login.rb
 - lib/zuora_api.rb
 - lib/zuora_api/exceptions.rb
 - lib/zuora_api/login.rb