eskomsepush_ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f1266710ca4484bed1a1be1995ac817892e94a4f1d079981176100b7841b650
+  data.tar.gz: ce9a6fdf5cefa43d87bceb864f36b79c4e8ab6e9e9e3dee1b13c629018bd3236
+SHA512:
+  metadata.gz: 5e99613d71c9d0d2ef40ae3940e1335af7668aeadda4d79388e9f86f36ce3051a3995eac1cbf8d4c6e836b692a0db40b19f83da4cc10b43927bf51169e848939
+  data.tar.gz: 68edc0cd79cf9e61cffeb8e9dc5d97c0ebcc02ac75c228c494e792d09f0c3306fec9104ece85ae8fa8cf104ff93907da8c3550e2f195613427c79c32c0d4a0db

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+3.1.3

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+## [1.0.0] - 2023-06-15
+
+- Initial release
+- All loadshedding, quota endpoints are covered.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at christiaannel9@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in eskomsepush.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "yard", "~> 0.9"

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    eskomsepush_ruby (0.1.3)
+      faraday (~> 2.7.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    faraday (2.7.10)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    json (2.6.3)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.52.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.4.2)
+    yard (0.9.34)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  eskomsepush_ruby!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 stiaannel
+
+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.

data/README.md

@@ -0,0 +1,74 @@
+# eskomsepush_ruby API Wrapper
+
+A Ruby wrapper for the EskomSePush API V2. This gem provides a simple and intuitive interface to interact with the EskomSePush services.
+
+## Important Notice
+
+Users of this library are bound by the terms in the EskomSePush's license agreement. Please review their [terms of service](https://sepush.co.za/license-agreement) before using this gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eskom_se_push_ruby'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install eskom_se_push_ruby
+```
+
+## Usage
+
+### Configuration
+
+```ruby
+esp = EskomSePush.client('your-api-key')
+```
+
+### Examples
+
+```ruby
+# Example of checking your quota
+quota = esp.quota.allowance
+puts quota
+
+area_schedule = esp.area_information('area_id')
+puts area_schedule
+```
+
+### Error Handling
+
+This gem will raise specific errors for different API responses:
+
+- `YourGemName::BadRequestError` - HTTP 400
+- `YourGemName::AuthenticationError` - HTTP 403
+- `YourGemName::NotFoundError` - HTTP 404
+- `YourGemName::RequestTimeoutError` - HTTP 408
+- `YourGemName::RateLimitError` - HTTP 429
+- `YourGemName::ServerError` - HTTP 500-599
+- `YourGemName::UnexpectedError` - Other errors
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/stiaannel/eskomsepush_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
+
+## Code of Conduct
+
+Everyone interacting in this project's codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/eskomsepush/client.rb

@@ -0,0 +1,165 @@
+# Includes
+require "faraday"
+require "uri"
+require "date"
+require "time"
+require "json"
+require "ostruct"
+
+# Error classes
+require_relative "exception"
+
+# Returns a new instance of API
+#
+# == Parameters:
+# token::
+#   Your API token
+# options::
+#   A hash of options
+#
+# == Returns:
+# A new instance of API
+module EskomSePush
+  class Client
+    def initialize(token, options = {})
+      raise EskomSePushError::InvalidTokenError, "Invalid token" if token.nil?
+
+      @token = token
+      @options = options
+      @quota = {}
+
+      begin
+        @connection = Faraday.new("https://developer.sepush.co.za")
+        @connection.headers["token"] = @token
+      rescue Faraday::ConnectionFailed
+        raise EskomSePushError::UnexpectedError
+      end
+    end
+
+    # Method to get your remaining API Quota/Allowance
+    #
+    # == Parameters:
+    # None
+    #
+    # == Returns:
+    # OpenStruct object with the quota information
+    #
+    def check_allowance
+      response = @connection.get("/business/2.0/api_allowance")
+      handle_response(response)
+    end
+
+    # Method to get the current status of the Eskom Loadshedding
+    #
+    # == Parameters:
+    # None
+    def status
+      response = @connection.get("/business/2.0/status")
+      handle_response(response)
+    end
+
+    # Search for the areaID of a specific area
+    #
+    # == Parameters:
+    # text::
+    #   The name of the area you want to search for
+    #
+    # == Returns:
+    # Response object from handle_response
+    def areas_search(text = nil)
+      raise EskomSePushError::BadRequestError if text.nil?
+
+      response = @connection.get("/business/2.0/areas_search?text=#{text}")
+      puts response
+      handle_response(response)
+    end
+
+    # Get the area information for a specific area
+    #
+    # == Parameters:
+    # area_id::String
+    #   The areaID of the area you want to get information for
+    # test::String
+    #   Whether you would like to use test data or not, valid options
+    #   are current and future
+    def area_information(area_id = nil, _test = nil)
+      raise EskomSePushError::BadRequestError if area_id.nil?
+
+      url = "/business/2.0/area?id=#{area_id}" + (_test.nil? ? "" : "&test=#{_test}")
+      response = @connection.get(url)
+      handle_response(response)
+    end
+
+    # Get a list of all nearby areas
+    #
+    # == Parameters:
+    # lat::String
+    #   The latitude of the area you want to get nearby areas for
+    # long::String
+    #   The longitude of the area you want to get nearby areas for
+    #
+    # == Returns:
+    # Response object from handle_response
+    def areas_nearby(lat = nil, long = nil)
+      raise EskomSePushError::BadRequestError if lat.nil? || long.nil?
+
+      response = @connection.get("/business/2.0/areas_nearby?lat=#{lat}&long=#{long}")
+      handle_response(response)
+    end
+
+    # Get a list of all nearby topics
+    #
+    # == Parameters:
+    # lat::String
+    #   The latitude of the area you want to get nearby topics for
+    # long::String
+    #   The longitude of the area you want to get nearby topics for
+    #
+    # == Returns:
+    # Response object from handle_response
+    def topics_nearby(lat = nil, long = nil)
+      raise EskomSePushError::BadRequestError if lat.nil? || long.nil?
+
+      response = @connection.get("/business/2.0/topics_nearby?lat=#{lat}&long=#{long}")
+      handle_response(response)
+    end
+
+    private
+
+    # Private Method to handle the responses from the API
+    #
+    # == Parameters:
+    # response::
+    #   The response object from the API
+    #
+    # == Returns:
+    # Parsed response object. Will raise errors if the API returns an unsucessful response.
+    #
+    def handle_response(response)
+      return EskomSePushError::UnexpectedError if response.nil?
+
+      if response.status != 200 || response.body["error"]
+        case response.status
+        when 400
+          raise EskomSePushError::BadRequestError
+        when 403
+          raise EskomSePushError::AuthenticationError
+        when 404
+          raise EskomSePushError::NotFoundError
+        when 408
+          raise EskomSePushError::RequestTimeoutError
+        when 429
+          raise EskomSePushError::RateLimitError
+        when 500..599
+          raise EskomSePushError::ServerError
+        else
+          raise EskomSePushError::UnexpectedError
+        end
+      else
+        JSON.parse(response.body, object_class: OpenStruct)
+      end
+    end
+
+    alias quota check_allowance
+  end
+end

data/lib/eskomsepush/exception.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module EskomSePush
+  # EskomSePush Error Class, subclass from StandardError to host
+  # all the errors from the EskomSePush API
+  class EskomSePushError < StandardError
+    # Error class that will be raised when the auth token is invalid
+    class InvalidTokenError < EskomSePushError
+      def message
+        "The Auth Token you provided was invalid."
+      end
+    end
+
+    # Error class that will be raised when the API returns a 429
+    # Implying that you have been rate limited, or you have exceeded
+    # your API quota/allowance
+    class RateLimitError < EskomSePushError
+      def message
+        "You have exceeded your API quota/allowance."
+      end
+    end
+
+    # Error class that will be raised when the API returns a 400
+    # Implying that the request you sent was invalid
+    class BadRequestError < EskomSePushError
+      def message
+        "The request you sent was invalid."
+      end
+    end
+
+    # Error class that will be raised when the API returns a 403
+    # Implying that the request you sent was not authenticated.
+    # Check your API token. And ensure it is valid during initialization.
+    class AuthenticationError < EskomSePushError
+      def message
+        "Authentication Error, check your credentials."
+      end
+    end
+
+    # Error class that will be raised when the API returns a 404
+    # Implying that the resource you requested was not found.
+    # Check the URL you are trying to access.
+    class NotFoundError < EskomSePushError
+      def message
+        "The resource you requested was not found."
+      end
+    end
+
+    # Error class that will be raised when the API returns a 408
+    # Implying that the request you sent timed out.
+    class RequestTimeoutError < EskomSePushError
+      def message
+        "The request you sent timed out."
+      end
+    end
+
+    # Error class that will be raised when the API returns a 5xx error
+    # Implying that the API returned a server error and you should try again later.
+    class ServerError < EskomSePushError
+      def message
+        "The SePush API returned a server error."
+      end
+    end
+
+    # Error class that will be raised for unexpected errors
+    # Implying that something went wrong while parsing the response data.
+    class UnexpectedError < EskomSePushError
+      def message
+        "Something went wrong while parsing your response data."
+      end
+    end
+  end
+end

data/lib/eskomsepush/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module EskomSePush
+  # Static Version of EskomSePush Rubygem
+  VERSION = "1.0.0"
+end

data/lib/eskomsepush_ruby.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "eskomsepush/version"
+require_relative "eskomsepush/client"
+
+# EskomSePush API Wrapper Rubygem
+#
+# This is a Rubygem that wraps the EskomSePush API. It allows you to easily integrate the
+# EskomSePush API into your Ruby applications.
+#
+# == Usage:
+#   require 'eskomsepush_ruby'
+#   esp = EskomSePush.client("{{token}}")
+#   esp.get_quota
+module EskomSePush
+  def self.client(api_key)
+    Client.new(api_key)
+  end
+end

data/sig/eskomsepush.rbs

@@ -0,0 +1,4 @@
+module EskomSePush
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: eskomsepush_ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- stiaannel
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.7
+description: EskomSePush API Wrapper Rubygem
+email:
+- christiaannel9@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/eskomsepush/client.rb
+- lib/eskomsepush/exception.rb
+- lib/eskomsepush/version.rb
+- lib/eskomsepush_ruby.rb
+- sig/eskomsepush.rbs
+homepage: https://github.com/stiaannel/eskomsepush_ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/stiaannel/eskomsepush_ruby
+  source_code_uri: https://github.com/stiaannel/eskomsepush_ruby
+  changelog_uri: https://github.com/stiaannel/eskomsepush_ruby/blob/master/CHANGELOG.md
+  documentation_uri: https://stiaannel.co.za/eskomsepush_ruby/
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: EskomSePush API Wrapper Rubygem
+test_files: []