bestchange-api 1.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fefd2ae756cf40bfa5313e56c56bc473c0677dfc13873c5dea2a527ce901f551
-  data.tar.gz: 1c031422cbff5f5f610c750b9dd1fdbcbfa0fbf6c578aa7d15efabb1282f1d1b
+  metadata.gz: 5dbecec983d7bc4299795c4ef489c5c63c6e90c33ef70144c8521bd2420fd067
+  data.tar.gz: 2e2196a4c4c458d42ec13dd530e423db8b0a9016636be8a1b074a5bfc771a395
 SHA512:
-  metadata.gz: 2626dd57b231e3e8450b29805bbb58de6994842546c9b2b2dde3e6a3aef0e064a5f0d2c7eff5a98840afc3122b38afdf2ea6439195409292543b3e386ea8c13c
-  data.tar.gz: b0bcf4bff9cce0413c69fdca33e90f0fd7c9a7949dc91633e561f5d6b2d18ad6ff958c5cc2463ca86b8109781a56249f00cf7a1d14dcda334053a30e44dc2649
+  metadata.gz: 61a22cb80ad3c8f6abec0da2dcca59f3a5829b0be7211b14e45e432196d6fc1c581b80420351d9dad1b2cff154a1755a67a3b92355be4d182f63096a6cd58bda
+  data.tar.gz: b837ec968c2959340e7363f7ea3c6f40f1c47e2b991f729df190fe67dc2d0d27fa6394b1f2933581a1055f810c7b1a81f00afbf6bd1b9d0587faff2436686e8a

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change log
 
+## [1.1]
+Fix tempfile location
+
+## [1.0]
+Add new Api interface, introduce Zip objects
+
 ## [0.7]
 Minor improvements
 

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

@@ -17,11 +17,7 @@ module Bestchange
     attr_reader :conn
 
     def request(request = default_request)
-      response = conn.request(request)
-
-      return response unless block_given?
-
-      yield response
+      conn.request(request)
     end
 
     private

data/lib/bestchange/version.rb

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

data/lib/bestchange/zip_builder.rb

@@ -12,7 +12,16 @@ module Bestchange
       zip_file = Tempfile.new('', encoding: ARCHIVE_DATA_ENCODING)
       zip_file.write(@response_body)
       zip_file.rewind
-      zip_file
+
+      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

@@ -9,14 +9,23 @@ module Bestchange
     end
 
     def call(filename)
+      tempfile = Tempfile.new(filename)
+
       Zip::File.open(@zip_file) do |zip_file|
         entry = zip_file.find_entry(filename)
 
-        tempfile = Tempfile.new(filename)
-
         entry.extract(tempfile) { true }
+      end
+
+      tempfile.rewind
 
-        tempfile.rewind
+      if block_given?
+        begin
+          yield tempfile
+        ensure
+          tempfile.close
+        end
+      else
         tempfile
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bestchange-api
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.1'
 platform: ruby
 authors:
 - Kirill Karpinovsky