EskomSePush 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 986e9ba3c964e53d5dec933e4a94748a10637754f88832ed6c4218be75ac03f5
-  data.tar.gz: 32267164c397c93246fe311870e063fea8100738c999ef8d26dc15711ea76128
+  metadata.gz: 3c195b94cb2b0a32e7ca57ea9c6eedd71ce35595bd3064e989c20b442e29e27f
+  data.tar.gz: 47b507de0e2f9c99a2a217dacf7f38cb97f4872e58ceffed9ea821122c4b8915
 SHA512:
-  metadata.gz: 811f693b184dfbb801b9c31d3c04c31bf9c7c3aa8001dd9afd7f0c50de729073e119fc954da95b1daa9e4c3ace9059f92347d5e954be7b574e6ddea66b5c6ca5
-  data.tar.gz: e22302a84ea0401f3b963962ad59742c5f67561a94d7716bac085bb5dfbe22dc639f6d3dc8b9a2fc1e344c68bed1966961fda7dae9926e4734d543508dcda413
+  metadata.gz: 0dff6e1db9a1bda6d5a31c29791f871045341e8ab345d65dd3b952ca99a71acd708ff9476a5132e7a1b0bc715568fb35079eca635c94c780672e63aee2a0f7e0
+  data.tar.gz: '03036719db6bceb98e9970d4bfdf88b295f6510fcc1b62758cb740df0ca9369554cfd5c43b68c6524316497bc9c3dc5b0e4ab06b83fbbfc82d8e456a9c5c748d'

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    EskomSePush (0.0.3)
-      api_pattern (~> 0.0.1)
+    EskomSePush (0.0.4)
+      api_pattern (~> 0.0.4)
 
 GEM
   remote: https://rubygems.org/
@@ -34,7 +34,7 @@ GEM
     addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
     ansi (1.5.0)
-    api_pattern (0.0.1)
+    api_pattern (0.0.4)
       active_attr (~> 0.15.4)
       httparty (~> 0.21.0)
       nokogiri (~> 1.14.3)

data/README.md

@@ -35,6 +35,10 @@ Or install it yourself as:
   client.areas_search(text: "fourways")
   client.topics_nearby(latitude: "-26.0269658", longitude: "28.0137339") # Can submit as a Float too
   client.check_allowance
+
+  # Historic data polls the EskomSePush Google sheet
+  # Does not need authorisation but Google does throttle calls to their servers
+  client.historic_data
 ```
 
 ### Endpoints
@@ -44,6 +48,7 @@ Or install it yourself as:
 - Areas Search (Text)
 - Topics Nearby
 - Check Allowance
+- Historic Data (Google Sheet returned as CSV)
 - Constants
 
 ## Development

data/eskom_se_push.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "api_pattern", "~> 0.0.1"
+  spec.add_dependency "api_pattern", "~> 0.0.4"
 
   # Development dependancies
   spec.add_development_dependency "rake", "~> 13.0.6"

data/lib/eskom_se_push/client.rb

@@ -1,13 +1,11 @@
 module EskomSePush
-  class Client
+  class Client < ApiPattern::Client
     include ::EskomSePush::Constants
 
     attr_reader :token, :base_path, :port
 
-    def initialize(token:, base_path: BASE_URI, port: BASE_PORT)
-      @token = token
-      @base_path = base_path
-      @port = port
+    def initialize(token:, base_path: BASE_URI, port: BASE_PORT, content_type: CONTENT_TYPE)
+      super(token: token, base_path: base_path, port: port, content_type: content_type)
     end
 
     def self.compatible_api_version
@@ -49,94 +47,11 @@ module EskomSePush
       authorise_and_send(http_method: :get, path: 'api_allowance')
     end
 
-    private
+    def historic_data(process: true)
+      response = unauthorised_and_send(http_method: :get, path: "", custom_url: HISTORY_URL, format: :csv)
+      return response unless process
 
-    def unauthorised_and_send(http_method:, path:, payload: {}, params: {})
-      start_time = get_micro_second_time
-
-      response = HTTParty.send(
-        http_method.to_sym,
-        construct_base_path(path, params),
-        body: payload,
-        headers: { 'Content-Type': 'application/json' },
-        port: port,
-        format: :json
-      )
-
-      end_time = get_micro_second_time
-      construct_response_object(response, path, start_time, end_time)
-    end
-
-    def authorise_and_send(http_method:, path:, payload: {}, params: {})
-      start_time = get_micro_second_time
-
-      response = HTTParty.send(
-        http_method.to_sym,
-        construct_base_path(path, params),
-        body: payload,
-        headers: { 'Content-Type': 'application/json', Token: token },
-        port: port,
-        format: :json
-      )
-
-      end_time = get_micro_second_time
-      construct_response_object(response, path, start_time, end_time)
-    end
-
-    def construct_response_object(response, path, start_time, end_time)
-      {
-        'body' => parse_body(response, path),
-        'headers' => response.headers,
-        'metadata' => construct_metadata(response, start_time, end_time)
-      }
-    end
-
-    def construct_metadata(response, start_time, end_time)
-      total_time = end_time - start_time
-
-      {
-        'start_time' => start_time,
-        'end_time' => end_time,
-        'total_time' => total_time
-      }
-    end
-
-    def body_is_present?(response)
-      !body_is_missing?(response)
-    end
-
-    def body_is_missing?(response)
-      response.body.nil? || response.body.empty?
-    end
-
-    def parse_body(response, path)
-      parsed_response = JSON.parse(response.body) # Purposely not using HTTParty
-
-      if parsed_response.dig(path.to_s)
-        parsed_response.dig(path.to_s)
-      else
-        parsed_response
-      end
-    rescue JSON::ParserError => _e
-      response.body
-    end
-
-    def get_micro_second_time
-      (Time.now.to_f * 1000000).to_i
-    end
-
-    def construct_base_path(path, params)
-      constructed_path = "#{base_path}/#{path}"
-
-      if params == {}
-        constructed_path
-      else
-        "#{constructed_path}?#{process_params(params)}"
-      end
-    end
-
-    def process_params(params)
-      params.keys.map { |key| "#{key}=#{params[key]}" }.join('&')
+      response["body"].split("\r\n")
     end
   end
 end

data/lib/eskom_se_push/constants.rb

@@ -1,7 +1,9 @@
 module EskomSePush
   module Constants
     BASE_URI = "https://developer.sepush.co.za/business/2.0/"
+    HISTORY_URL = "https://docs.google.com/spreadsheets/d/1ZpX_twP8sFBOAU6t--Vvh1pWMYSvs60UXINuD5n-K08/export?usp=sharing&format=csv"
     BASE_PORT = 80
+    CONTENT_TYPE = 'application/json'
 
     FREE_LIMIT = 50
     AREAS_SEARCH_FREE_COST = 5

data/lib/eskom_se_push/version.rb

@@ -1,3 +1,3 @@
 module EskomSePush
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/eskom_se_push.rb

@@ -1,6 +1,8 @@
 require 'httparty'
 require 'nokogiri'
 
+require 'api-pattern'
+
 require 'eskom_se_push/version'
 require 'eskom_se_push/constants'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: EskomSePush
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - trex22
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-24 00:00:00.000000000 Z
+date: 2023-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: api_pattern
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement