bestchange 1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d8081c2cc7f9b963ede0ad28cc64923c9a550f0b9cbd4f388bf17600ccfc6ade
+  data.tar.gz: f4813b0a6675c55e9c17c57a2ddbbe71f13706241eb21a43afcfb250cf305487
+SHA512:
+  metadata.gz: 573465318a1d906fe83c98659ebbb4167d473bfeb3cafe4e07869133add1363077958026c3771c2f24afea9957db5b113dc6687055b63a771ce70e360d4fbf73
+  data.tar.gz: 477626b6f7183c6da3390c6e204755c42f26274f5b0bada6ae0fb671c511d3259ecf8e23376134cf231a84a4894dab3db8c5cdd21c8a5071dcefa7aac5d6f3db

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  TargetRubyVersion: 3.1.3
+Style/Documentation:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 15

data/API_DOC.txt

@@ -0,0 +1,40 @@
+Файл перемещен на адрес http://api.bestchange.ru/info.zip
+
+Вы можете использовать курсы от нашего сервиса с учетом указания ссылок на сайт www.bestchange.ru
+
+На данный момент у нас нет обычного API. Получать курсы обменных пунктов можно, загружая ZIP-архив — http://api.bestchange.ru/info.zip
+Архив обновляется регулярно вместе с сайтом и содержит сразу всю выгрузку курсов обмена. Загружать его можно не чаще, чем раз в 30 секунд. 
+
+Внутри находится несколько CSV-файлов с данными в кодировке Windows-1251. Как их распарсить:
+
+bm_cy.dat — список валют в формате:
+• ID валюты
+• Позиция валюты в табличном списке на сайте www.bestchange.ru
+• Название валюты
+ 
+bm_exch.dat — список обменных пунктов в формате:
+• ID обменного пункта
+• Название обменного пункта
+ 
+bm_rates.dat — список курсов обмена в формате:
+• ID отдаваемой валюты
+• ID получаемой валюты
+• ID обменного пункта
+• Курс обмена (отдать)
+• Курс обмена (получить)
+• Резерв получаемой валюты
+• Отзывы (претензии и положительные через символ ".")
+• Не используется
+• Минимальная сумма обмена
+• Максимальная сумма обмена
+• ID города (для направлений с наличными)
+
+bm_cities.dat — список городов в формате:
+• ID города
+• Название города
+
+Переходы на сайты обменных пунктов возможны через редирект по ID, пример:
+https://www.bestchange.ru/click.php?id=1
+
+Имеется готовый код для парсинга на языке PHP, вы можете скачать его по ссылке:
+https://www.bestchange.ru/bm/zip_parsing.zip

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Change log
+
+## [1.1]
+Fix tempfile location
+
+## [1.0]
+Add new Api interface, introduce Zip objects
+
+## [0.7]
+Minor improvements
+
+## [0.6]
+Pass zip entry via before_extract block
+
+## [0.5]
+Add before_extract block
+
+## [0.4]
+Do not delete already existed files
+
+## [0.3]
+Fix configuration access
+
+## [0.2]
+Fix missing dependencies. Move requirements to Api class
+
+## [0.1]
+Add basic functionality

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at karpinovsky@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    bestchange-api (1.1)
+      rubyzip (= 2.3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    coderay (1.1.3)
+    json (2.6.3)
+    method_source (1.0.0)
+    minitest (5.17.0)
+    minitest-reporters (1.6.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rubocop (1.47.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    rubyzip (2.3.2)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  bestchange-api!
+  minitest (= 5.17.0)
+  minitest-reporters
+  pry (= 0.14.2)
+  rubocop (= 1.47.0)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Kirill
+
+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,86 @@
+
+# bestchange-api
+
+bestchange-api is a simple library for getting data from Bestchange aggregator
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bestchange-api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install bestchange-api
+
+## Usage
+[Bestchange api description](https://github.com/karpinovsky/bestchange-api/blob/master/API_DOC.txt)
+
+### info.zip
+
+```ruby
+require 'bestchange'
+
+api_client = Bestchange::Api.new
+response = api_client.request # this will call api.bestchange.ru/info.zip by default
+archive = Bestchange::ZipBuilder.new(response.body).call
+tempfile = Bestchange::ZipExtractor.new(archive).call('bm_rates.dat')
+```
+
+**NOTE**: Do not forget to close and unlink files at the end
+```ruby
+archive.close
+tempfile.close
+```
+
+### Using blocks
+The `Bestchange::ZipBuilder` and `Bestchange::ZipExtractor` classes support using blocks to ensure that tempfiles are closed automatically. This is useful when you want to avoid manual file management and prevent possible leaks
+```ruby
+response = Bestchange::Api.new.request
+
+Bestchange::ZipBuilder.new(response.body).call do |archive|
+  # Work with archive here
+  # archive will be closed automatically when the block finishes
+  Bestchange::ZipExtractor.new(archive).call('bm_rates.dat') do |bm_rates|
+    # Work with bm_rates here
+    # bm_rates will be closed automatically when the block finishes
+  end
+end
+```
+
+### Custom connection
+You can pass your own http connection object while initializing an api client. This can be useful if you want to set custom timeouts, for example
+```ruby
+require  'bestchange'
+
+uri = URI(Bestchange::Api::BASE_URI)
+conn = Net::HTTP.new(uri.host, uri.port)
+conn.open_timeout = 5
+conn.read_timeout = 10
+api_client = Bestchange::Api.new(conn)
+```
+
+### Custom request
+You can provide your own http request object to the `#request` method
+```ruby
+require  'bestchange'
+
+request = Net::HTTP::Head.new(URI(Bestchange::Api::BASE_URI))
+response = api_client.request(request)
+created_at = response['Date']
+```
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the bestchange-api project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/karpinovsky/bestchange-api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'bestchange'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/bestchange/api.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+require 'net/http'
+require 'tempfile'
+require 'timeout'
+require 'zip'
+
+module Bestchange
+  class Api
+    BASE_URI = 'http://api.bestchange.ru/info.zip'
+
+    def initialize(conn = default_conn)
+      @conn = conn
+    end
+
+    attr_reader :conn
+
+    def request(request = default_request)
+      conn.request(request)
+    end
+
+    private
+
+    def default_conn
+      Net::HTTP.new(URI(BASE_URI).host, URI(BASE_URI).port)
+    end
+
+    def default_request
+      Net::HTTP::Get.new(URI(BASE_URI))
+    end
+  end
+end

data/lib/bestchange/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Bestchange
+  VERSION = '1.1'
+end

data/lib/bestchange/zip_builder.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Bestchange
+  class ZipBuilder
+    ARCHIVE_DATA_ENCODING = 'ASCII-8BIT'
+
+    def initialize(response_body)
+      @response_body = response_body
+    end
+
+    def call
+      zip_file = Tempfile.new('', encoding: ARCHIVE_DATA_ENCODING)
+      zip_file.write(@response_body)
+      zip_file.rewind
+
+      if block_given?
+        begin
+          yield zip_file
+        ensure
+          zip_file.close
+        end
+      else
+        zip_file
+      end
+    end
+  end
+end

data/lib/bestchange/zip_extractor.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'zip'
+
+module Bestchange
+  class ZipExtractor
+    def initialize(zip_file)
+      @zip_file = zip_file
+    end
+
+    def call(filename)
+      tempfile = Tempfile.new(filename)
+
+      Zip::File.open(@zip_file) do |zip_file|
+        entry = zip_file.find_entry(filename)
+
+        entry.extract(tempfile) { true }
+      end
+
+      tempfile.rewind
+
+      if block_given?
+        begin
+          yield tempfile
+        ensure
+          tempfile.close
+        end
+      else
+        tempfile
+      end
+    end
+  end
+end

data/lib/bestchange.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'bestchange/api'
+require_relative 'bestchange/zip_builder'
+require_relative 'bestchange/zip_extractor'
+
+module Bestchange
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: bestchange
+version: !ruby/object:Gem::Version
+  version: '1.1'
+platform: ruby
+authors:
+- Kirill Karpinovsky
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.17.0
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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.14.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.47.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.47.0
+description: A simple library for getting data from Bestchange aggregator
+email: karpinovsky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- API_DOC.txt
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/bestchange.rb
+- lib/bestchange/api.rb
+- lib/bestchange/version.rb
+- lib/bestchange/zip_builder.rb
+- lib/bestchange/zip_extractor.rb
+homepage: https://github.com/karpinovsky/bestchange
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/karpinovsky/bestchange
+  source_code_uri: https://github.com/karpinovsky/bestchange
+  bug_tracker_uri: https://github.com/karpinovsky/bestchange/issues
+  changelog_uri: https://github.com/karpinovsky/bestchange/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.3
+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: Bestchange client
+test_files: []