bestchange-api 0.7 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4519573ffcd91610bf68a30544ebd17c00506ab8c052b5412b74ff348f07d8a
-  data.tar.gz: c6e1e36c2ed0d7c35a374e00576c8c5de2f433e86edb986a0ceaf5e17a04e167
+  metadata.gz: 5dbecec983d7bc4299795c4ef489c5c63c6e90c33ef70144c8521bd2420fd067
+  data.tar.gz: 2e2196a4c4c458d42ec13dd530e423db8b0a9016636be8a1b074a5bfc771a395
 SHA512:
-  metadata.gz: 8677e25eb2333d11e437e0b06eb64bcc122994b12fba0b81693e10dee37a6f31ce71d47a3f124929dafd865d72280db7e37df2c3109c7f0c4d2231c7b7d89c84
-  data.tar.gz: 5459ab729ad2777e2981b8ba1b55fd37a88a8720d85ddbf18167dcb2587c095b0c5ba6e85f1a2583cad53446545ad569e77fcbc53491f71134cc53d867285e02
+  metadata.gz: 61a22cb80ad3c8f6abec0da2dcca59f3a5829b0be7211b14e45e432196d6fc1c581b80420351d9dad1b2cff154a1755a67a3b92355be4d182f63096a6cd58bda
+  data.tar.gz: b837ec968c2959340e7363f7ea3c6f40f1c47e2b991f729df190fe67dc2d0d27fa6394b1f2933581a1055f810c7b1a81f00afbf6bd1b9d0587faff2436686e8a

data/.rubocop.yml

@@ -1,3 +1,5 @@
+AllCops:
+  TargetRubyVersion: 3.1.3
 Style/Documentation:
   Enabled: false
 Metrics/MethodLength:

data/CHANGELOG.md

@@ -1,7 +1,13 @@
 # Change log
 
+## [1.1]
+Fix tempfile location
+
+## [1.0]
+Add new Api interface, introduce Zip objects
+
 ## [0.7]
-Small improvements
+Minor improvements
 
 ## [0.6]
 Pass zip entry via before_extract block

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bestchange-api (0.7)
+    bestchange-api (1.0)
       rubyzip (= 2.3.2)
 
 GEM

data/README.md

@@ -1,3 +1,4 @@
+
 # bestchange-api
 
 bestchange-api is a simple library for getting data from Bestchange aggregator
@@ -21,31 +22,61 @@ Or install it yourself as:
 ## Usage
 [Bestchange api description](https://github.com/karpinovsky/bestchange-api/blob/master/API_DOC.txt)
 
-Add your own configuration or use the default one
+### info.zip
 
 ```ruby
 require 'bestchange'
 
-Bestchange.configure do |config|
-  config.dir = "path/to/your/custom/folder" # default is Dir.pwd
-  config.timeout = 20 # Timeout for getting & parsing data, default is 40
-end
+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')
 ```
 
-Fetch data
+**NOTE**: Do not forget to close and unlink files at the end
 ```ruby
-Bestchange::Api.get_files(['bm_rates.dat']) # => [File] 
+archive.close
+tempfile.close
 ```
-### &before_extract
-You can also pass a block that will be called before `Zip::Entry#extract`. It might be helpful if you need to remove existed files or change files destination for example
+
+### 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
-before_extract = ->(_zip_entry, pathname) do
-  pathname.delete if pathname.exist?
+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'
 
-Bestchange::Api.get_files(['bm_rates.dat'], &before_extract)
+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).

data/lib/bestchange/api.rb

@@ -7,49 +7,27 @@ require 'timeout'
 require 'zip'
 
 module Bestchange
-  module Api
-    extend self
+  class Api
+    BASE_URI = 'http://api.bestchange.ru/info.zip'
 
-    def get_files(filenames, &before_extract)
-      Timeout.timeout(Bestchange.configuration.timeout) do
-        fetch_files(filenames, &before_extract)
-      end
+    def initialize(conn = default_conn)
+      @conn = conn
     end
 
-    private
+    attr_reader :conn
 
-    def fetch_files(filenames, &before_extract)
-      response = make_request
-      archive = make_archive(response)
-      extract_files(archive, filenames, &before_extract)
-    ensure
-      archive.close if defined?(archive)
+    def request(request = default_request)
+      conn.request(request)
     end
 
-    def make_request
-      Net::HTTP.get(URI(BASE_URI))
-    end
+    private
 
-    def make_archive(response)
-      archive = Tempfile.new(ARCHIVE_DATA_FILENAME, encoding: ARCHIVE_DATA_ENCODING)
-      archive.write(response)
-      archive
+    def default_conn
+      Net::HTTP.new(URI(BASE_URI).host, URI(BASE_URI).port)
     end
 
-    def extract_files(archive, filenames, &before_extract)
-      Zip::File.open(archive) do |zip_file|
-        filenames.map do |filename|
-          entry = zip_file.find_entry(filename)
-
-          pathname = Pathname.new(Bestchange.configuration.dir).join(filename)
-
-          before_extract&.call(entry, pathname)
-
-          zip_file.extract(entry, pathname)
-
-          pathname.open
-        end
-      end
+    def default_request
+      Net::HTTP::Get.new(URI(BASE_URI))
     end
   end
 end

data/lib/bestchange/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bestchange
-  VERSION = '0.7'
+  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

@@ -1,24 +1,8 @@
 # frozen_string_literal: true
 
 require_relative 'bestchange/api'
-require_relative 'bestchange/configuration'
+require_relative 'bestchange/zip_builder'
+require_relative 'bestchange/zip_extractor'
 
 module Bestchange
-  ARCHIVE_DATA_FILENAME = 'info.zip'
-  ARCHIVE_DATA_ENCODING = 'ASCII-8BIT'
-
-  BASE_URI = "http://api.bestchange.ru/#{ARCHIVE_DATA_FILENAME}".freeze
-
-  DIRECTORY = Dir.pwd
-  TIMEOUT = 40
-
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
-
-  def self.configure
-    return configuration unless block_given?
-
-    yield(configuration)
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bestchange-api
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: '1.1'
 platform: ruby
 authors:
 - Kirill Karpinovsky
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-17 00:00:00.000000000 Z
+date: 2023-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -89,8 +89,9 @@ files:
 - bin/setup
 - lib/bestchange.rb
 - lib/bestchange/api.rb
-- lib/bestchange/configuration.rb
 - lib/bestchange/version.rb
+- lib/bestchange/zip_builder.rb
+- lib/bestchange/zip_extractor.rb
 homepage: https://github.com/karpinovsky/bestchange-api
 licenses:
 - MIT

data/lib/bestchange/configuration.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Bestchange
-  class Configuration
-    def dir
-      @dir || Bestchange::DIRECTORY
-    end
-
-    def timeout
-      @timeout || Bestchange::TIMEOUT
-    end
-
-    attr_writer :dir, :timeout
-  end
-end