ensuppar 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eb5b4d09a78d790db2fad1e548fef8dd2409bfca87d55c3a4428fe0885b7e22
-  data.tar.gz: 2bf394b2c5f67559a036f4cc0ffd9620d3143b8a53da32f8559d3080d8a23309
+  metadata.gz: b07e512171277fff8347b3eeb9f108d23f71dcb8b9ce1552648234b0abbec391
+  data.tar.gz: 01d611a95d88ba81698f48ca41ef449105c19b7b095039defd9f942bb9c253eb
 SHA512:
-  metadata.gz: 515faf14ec4d94a10694bc575a963dcfb5fb771728fe64527341b504c6b54cc01503a582f3c7a8ec81df97c14082d3a2d51e6ebcdd3961900e84a7ec7fde1738
-  data.tar.gz: 60243c058120f5f5eff96f1aac0fe99881a0e2bd32fe56ed004628eda17559fa661f6e08b0fbdf147bb6499673ed858e116faa58d02ee018107d4b3d69b66bc1
+  metadata.gz: f9bed5ae50dea3f07b02648a536b25e25bc8c2248770ae195ef82ad84234f8175bf6dc86536ff35fea21b8c0db75608d6b48a9f980a196932d5e113ff8faaee5
+  data.tar.gz: 21c1700cba1f813aa3afb3160a43f1b080d24c7a5b88714bce41342cf0c5e21bfdc8836663644896c878b4a1d5b17c41b6f7cbd0bd0a7d67b4549360d8b45b7f

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [1.0.0] - 2022-11-26
+
+- Added database
+- Added logic for fetching result from server
+- Added parcing logic
+- Buildings can have many energy schedules
+- Added filtering by street and number
+
 ## [0.1.0] - 2022-11-26
 
 - Initial release

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    ensuppar (1.0.0)
+      httparty
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    method_source (1.0.0)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    multi_xml (0.6.0)
+    nokogiri (1.13.9-x86_64-linux)
+      racc (~> 1.4)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.6.0)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  ensuppar!
+  pry (~> 0.13.1)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.3.24

data/README.md

@@ -1,8 +1,6 @@
 # Ensuppar
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ensuppar`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Ensuppar is a gem that allows fetch data from energy website, parse it and return collection of objects for manipulating of them.
 
 ## Installation
 
@@ -16,7 +14,27 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+#### Put this gem at your Gemfile
+
+```
+gem 'ensuppar'
+```
+
+#### Configure it
+
+```
+Ensuppar.confiure do |conf|
+  host = "host/to/server"
+end
+```
+
+#### Get entities
+
+```
+Ensuppar.get_schedule(city: "Івано-Франківськ", street: "Незалежності", number: 40)
+```
+
+Parameters `street` and `number` is not required.
 
 ## Development
 

data/lib/ensuppar/configuration.rb

@@ -0,0 +1,15 @@
+module Ensuppar 
+  class Configuration
+    attr_writer :host
+
+    def initialize
+      @host = nil
+    end
+
+    def host
+      raise Errors::Configuration, "URL of Energy Supplying website is missing!" unless @host
+
+      @host
+    end
+  end
+end

data/lib/ensuppar/db/cities.json

@@ -0,0 +1,7 @@
+[
+  {
+    "city": "Івано-Франківськ",
+    "city_id": 31107,
+    "rem_id": "iv-fr_p"
+  }
+]

data/lib/ensuppar/detectors/city_detector.rb

@@ -0,0 +1,30 @@
+module Ensuppar
+  module Detectors
+    class CityDetector
+      DB_PATH = 'lib/ensuppar/db/cities.json'
+
+      attr_reader :city
+
+      def initialize(city:)
+        @city = city
+      end
+
+      def city_data 
+        @city_data ||= (get_db_cities.find do |city_data|
+          city_data['city'] == city
+        end || {}).transform_keys(&:to_sym)
+      end
+    
+      private
+
+        def get_db_cities
+          file = File.open DB_PATH
+          data = JSON.load file
+
+          file.close
+
+          data
+        end
+    end
+  end
+end

data/lib/ensuppar/entities/building.rb

@@ -0,0 +1,18 @@
+module Ensuppar
+  module Entities
+    class Building
+      attr_reader :city, :street, :number, :energy_schedules
+
+      def initialize(city:, street:, number:, energy_schedules: [])
+        @city = city
+        @street = street
+        @number = number
+        @energy_schedules = energy_schedules
+      end
+
+      def info
+        "#{city}, #{street} #{number}: #{energy_schedules.map(&:info).join(", ")}"
+      end
+    end
+  end
+end

data/lib/ensuppar/entities/energy_schedule.rb

@@ -0,0 +1,16 @@
+module Ensuppar
+  module Entities
+    class EnergySchedule
+      attr_reader :start_date, :end_date
+
+      def initialize(start_date: nil, end_date: nil)
+        @start_date = start_date
+        @end_date  = end_date
+      end
+
+      def info
+        " [ #{start_date} - #{end_date} ] "
+      end
+    end
+  end
+end

data/lib/ensuppar/errors/configuration.rb

@@ -0,0 +1,5 @@
+module Ensuppar
+  module Errors
+    class Configuration < StandardError; end
+  end
+end

data/lib/ensuppar/services/energy_suply_service/client.rb

@@ -0,0 +1,15 @@
+module Ensuppar
+  module Services
+    module EnergySuplyService
+      class Client
+        def self.city_filter_report(city_id:, rem_id:)
+          path = "GAVTurnOff/CityFilterPReport"
+          options = "cityList=#{city_id}&remList=#{rem_id}&dBegin=&dEnd=&allRem=false"
+          response = HTTParty.get("https://#{Ensuppar.configuration.host}/#{path}?#{options}")
+
+          Ensuppar::Services::EnergySuplyService::Parser.new(body: response.body).entities
+        end
+      end
+    end
+  end
+end

data/lib/ensuppar/services/energy_suply_service/parser.rb

@@ -0,0 +1,35 @@
+module Ensuppar
+  module Services
+    module EnergySuplyService
+      class Parser
+        attr_reader :body
+
+        def initialize(body: "")
+          @body = body
+        end
+
+        def parsed_body
+          @parsed_body ||= Nokogiri::HTML.parse(body) || ""
+        end
+
+        def entities
+          @entities ||= begin
+            parsed_body.xpath("//tbody").first.children.select do
+              |c| c.name == "tr"
+            end.map{|c| c.children}.map do |td|
+              data = td.select{|c| c.name == "td"}.map do |tdd|
+                tdd.children.first.text
+              end
+              
+              energy_schedule = Ensuppar::Entities::EnergySchedule.new(start_date: data[4], end_date: data[5])
+
+              Ensuppar::Entities::Building.new(
+                city: data[1], street: data[2], number: data[3], energy_schedules: [energy_schedule]
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ensuppar/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ensuppar
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/ensuppar.rb

@@ -1,8 +1,45 @@
 # frozen_string_literal: true
 
+require 'json'
+require 'httparty'
+require 'nokogiri'
+
 require_relative "ensuppar/version"
+require_relative "ensuppar/configuration"
+require_relative "ensuppar/errors/configuration"
+require_relative "ensuppar/detectors/city_detector"
+require_relative "ensuppar/entities/energy_schedule"
+require_relative "ensuppar/entities/building"
+require_relative "ensuppar/services/energy_suply_service/parser"
+require_relative "ensuppar/services/energy_suply_service/client"
 
 module Ensuppar
-  class Error < StandardError; end
-  # Your code goes here...
+  class << self
+    def get_schedule(city:, street: "", number: nil)
+      city_data = Detectors::CityDetector.new(city: city).city_data
+    
+      entities = Services::EnergySuplyService::Client.city_filter_report(
+        city_id: city_data[:city_id],
+        rem_id: city_data[:rem_id]
+      )
+
+      entities.select do |b|
+        cond = b.street == street || street == ""
+
+        (number.nil? && cond) || (number.to_s == b.number && cond)
+      end
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def reset
+      @configuration = Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ensuppar
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Misha Marusyk
@@ -9,7 +9,49 @@ autorequire:
 bindir: exe
 cert_chain: []
 date: 2022-11-26 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
 description: Ensuppar is a parser for energy supplying website.
 email:
 - misha.marusyk@gmail.com
@@ -21,10 +63,19 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/ensuppar.rb
+- lib/ensuppar/configuration.rb
+- lib/ensuppar/db/cities.json
+- lib/ensuppar/detectors/city_detector.rb
+- lib/ensuppar/entities/building.rb
+- lib/ensuppar/entities/energy_schedule.rb
+- lib/ensuppar/errors/configuration.rb
+- lib/ensuppar/services/energy_suply_service/client.rb
+- lib/ensuppar/services/energy_suply_service/parser.rb
 - lib/ensuppar/version.rb
 - sig/ensuppar.rbs
 homepage: https://github.com/mmarusyk/ensuppar