EskomSePush 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d496294815ae03ca8bc0dbd3740e512f650ff0a181630b82098cc4b2b65550c6
-  data.tar.gz: 0cb33efbb037b89804ca6e0cd98bb8f461696ef52bd4cb8fca9e2e509343dd59
+  metadata.gz: 3c195b94cb2b0a32e7ca57ea9c6eedd71ce35595bd3064e989c20b442e29e27f
+  data.tar.gz: 47b507de0e2f9c99a2a217dacf7f38cb97f4872e58ceffed9ea821122c4b8915
 SHA512:
-  metadata.gz: fea2a7feb5f5600d0cc84069ce2c412ada5423b4d2bb726fdbd52cae26b01ffc73599a8d463c641fc200da4cceae16d59ff4bf167802ec911c4c28168c6dfafb
-  data.tar.gz: 39c751ffc8c754ad4ede5e96dc9ff281a1ab70aca3181ab611cf92d3d0580078f286d97c581955539974e857265d682c467f94cb860a063cb5ba2acb4b21b475
+  metadata.gz: 0dff6e1db9a1bda6d5a31c29791f871045341e8ab345d65dd3b952ca99a71acd708ff9476a5132e7a1b0bc715568fb35079eca635c94c780672e63aee2a0f7e0
+  data.tar.gz: '03036719db6bceb98e9970d4bfdf88b295f6510fcc1b62758cb740df0ca9369554cfd5c43b68c6524316497bc9c3dc5b0e4ab06b83fbbfc82d8e456a9c5c748d'

data/.github/workflows/ruby-ci.yml

@@ -0,0 +1,24 @@
+name: Ruby Tests
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.2.2
+    - name: Cache dependencies
+      uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        key: v1-${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          v1-${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake test

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    EskomSePush (0.0.2)
-      active_attr (~> 0.15.4)
-      httparty (~> 0.21.0)
+    EskomSePush (0.0.4)
+      api_pattern (~> 0.0.4)
 
 GEM
   remote: https://rubygems.org/
@@ -35,6 +34,10 @@ GEM
     addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
     ansi (1.5.0)
+    api_pattern (0.0.4)
+      active_attr (~> 0.15.4)
+      httparty (~> 0.21.0)
+      nokogiri (~> 1.14.3)
     builder (3.2.4)
     coderay (1.1.3)
     concurrent-ruby (1.2.2)
@@ -53,15 +56,16 @@ GEM
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
     mini_mime (1.1.2)
-    minitest (5.15.0)
+    minitest (5.18.0)
     minitest-focus (1.3.1)
       minitest (>= 4, < 6)
-    minitest-reporters (1.5.0)
+    minitest-reporters (1.6.0)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    mocha (1.13.0)
+    mocha (2.0.2)
+      ruby2_keywords (>= 0.0.5)
     multi_xml (0.6.0)
     nokogiri (1.14.3-arm64-darwin)
       racc (~> 1.4)
@@ -81,27 +85,28 @@ GEM
     rake (13.0.6)
     rexml (3.2.5)
     ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
     timecop (0.9.6)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    webmock (3.14.0)
+    webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
-  arm64-darwin-20
+  arm64-darwin-22
 
 DEPENDENCIES
   EskomSePush!
-  minitest (~> 5.15.0)
+  minitest (~> 5.18.0)
   minitest-focus (~> 1.3.1)
-  minitest-reporters (~> 1.5.0)
-  mocha (~> 1.13.0)
-  pry (~> 0.14.1)
+  minitest-reporters (~> 1.6.0)
+  mocha (~> 2.0.2)
+  pry (~> 0.14.2)
   rake (~> 13.0.6)
-  timecop (~> 0.9.1)
-  webmock (~> 3.14.0)
+  timecop (~> 0.9.6)
+  webmock (~> 3.18.1)
 
 BUNDLED WITH
-   2.3.16
+   2.4.12

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Jason Chalom
+Copyright (c) 2023 Jason Chalom
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -23,6 +23,8 @@ Or install it yourself as:
 
 ## Usage
 
+`id` is found using `areas_search` or `areas_nearby`.
+
 ```ruby
   require 'eskom_se_push'
   client = EskomSePush::Client.new(token: 'Your token here')
@@ -33,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
@@ -42,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,16 +22,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "httparty", "~> 0.21.0"
-  spec.add_dependency "active_attr", "~> 0.15.4"
+  spec.add_dependency "api_pattern", "~> 0.0.4"
 
   # Development dependancies
   spec.add_development_dependency "rake", "~> 13.0.6"
-  spec.add_development_dependency "minitest", "~> 5.15.0"
+  spec.add_development_dependency "minitest", "~> 5.18.0"
   spec.add_development_dependency "minitest-focus", "~> 1.3.1"
-  spec.add_development_dependency "minitest-reporters", "~> 1.5.0"
-  spec.add_development_dependency "timecop", "~> 0.9.1"
-  spec.add_development_dependency "mocha", "~> 1.13.0"
-  spec.add_development_dependency "pry", "~> 0.14.1"
-  spec.add_development_dependency "webmock", "~> 3.14.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.6.0"
+  spec.add_development_dependency "timecop", "~> 0.9.6"
+  spec.add_development_dependency "mocha", "~> 2.0.2"
+  spec.add_development_dependency "pry", "~> 0.14.2"
+  spec.add_development_dependency "webmock", "~> 3.18.1"
 end

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.2"
+  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,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: EskomSePush
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - trex22
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-12 00:00:00.000000000 Z
+date: 2023-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: api_pattern
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
-- !ruby/object:Gem::Dependency
-  name: active_attr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.15.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.15.4
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.15.0
+        version: 5.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.15.0
+        version: 5.18.0
 - !ruby/object:Gem::Dependency
   name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
@@ -86,70 +72,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.6
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: 2.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 0.14.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 0.14.2
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.14.0
+        version: 3.18.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.14.0
+        version: 3.18.1
 description: A client for using the EskomSePush API in Ruby. Built from their api
   documentation. This is an unofficial project.
 email:
@@ -158,12 +144,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby-ci.yml"
 - ".gitignore"
+- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
@@ -192,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.4
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A client for using the EskomSePush API in Ruby.

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2020 trex22
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.