arh_archive 0.0.1.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d69c35d21f8997c879109b0050ae879a400c9e9ad1c9c298743e43174d0c254c
+  data.tar.gz: 1420159c2d82f24bec0d3263ed46ff5a4f6bf408fdb4a01975645aa67309cae2
+SHA512:
+  metadata.gz: 45480a4ee0b03a7367c38323987d32b0a99abd75a67de01a999969c61e86015ac2f25cb923fb58c7f4ab01e24b973e63c90b532038802ba953af4f8a5ba73800
+  data.tar.gz: f6d6ca53feb601addbacfad9bab06ea428af462e6b1fee47844c59838805a73d7b8b0f371d4f5c12ca5f0c9fc142d2ed1c733fa57a419fefcb1c84eccb21b43d

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.0.1.rc1 (17-02-2025)
+
+* Initial release

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,3 @@
+The MIT License
+
+Copyright (c) 2025 Maksim Korelskii

data/README.md

@@ -0,0 +1,57 @@
+# ArhArchive API Ruby interface
+
+This is a Ruby client that enables you to easily perform using [ArhArchive] for save images.
+
+## Prerequisites
+
+[Ruby 2.7+](https://www.ruby-lang.org/en/) and [RubyGems subsystem](https://rubygems.org/) is required.
+
+## Installation
+
+Install this gem by running:
+
+```
+$ gem install arh_archive
+```
+
+Or add it to your `Gemfile`:
+
+```ruby
+gem 'arh_archive'
+```
+
+And run:
+
+```
+bundle install
+```
+
+## Usage
+
+Include the client in your script:
+
+```ruby
+require 'arh_archive'
+```
+
+Next, instantiate the client:
+
+```ruby
+client = ArhArchive.client
+```
+
+And perform:
+
+```ruby
+client.save_images(number_of_document, page_from, page_to)
+```
+
+### Additional request parameters
+
+ Directory for save images.
+
+```ruby
+client.save_images(number_of_document, page_from, page_to, directory)
+```
+
+Licensed under the [MIT license](./LICENSE.md).

data/arh_archive.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require File.expand_path('lib/arh_archive/version', __dir__)
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'arh_archive'
+  spec.version               = ArhArchive::VERSION
+  spec.authors               = ['Maksim Korelskii']
+  spec.email                 = ['mkorelskii@gmail.com']
+  spec.summary               = 'Ruby interface.'
+  spec.description           = 'This is a Ruby client that enables you to easily perform using ' \
+                               'ArhArchive.'
+  spec.homepage              = 'https://github.com/MaksimKorelskii/arh_archive'
+  spec.license               = 'MIT'
+  spec.platform              = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.files = Dir['README.md', 'LICENSE.md',
+                   'CHANGELOG.md', 'lib/**/*.rb',
+                   'arh_archive.gemspec',
+                   'Gemfile']
+  spec.extra_rdoc_files = ['README.md']
+  spec.require_paths    = ['lib']
+
+  spec.add_dependency 'faraday', '~> 2.6'
+  spec.add_dependency 'zeitwerk', '~> 2.4'
+  spec.add_development_dependency 'rubocop', '~> 1.6'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.5'
+
+  spec.metadata = {
+    'source_code_uri' => 'https://github.com/MaksimKorelskii/arh_archive',
+    'rubygems_mfa_required' => 'true'
+  }
+end

data/lib/arh_archive/client.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ArhArchive
+  class Client
+    include ArhArchive::Request
+
+
+    def save_images(document, page_from, page_to, directory_path = "C://image_from_archive/#{document}", params = {})
+      while page_from <= page_to
+        save_image(document, page_from, page_to, directory_path, params)
+        page_from += 1
+      end
+    end
+
+    private
+
+    def save_image(document, page_from, _page_to, directory_path, params)
+      ArhArchive::Saver.new(get("/archive1/image/#{document}", {n: page_from}.merge(params)),
+                            document,
+                            page_from,
+                            directory_path)
+    end
+  end
+end

data/lib/arh_archive/connection.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ArhArchive
+  module Connection
+    BASE_URL = 'https://archives.dvinaland.ru'
+    def connection
+      Faraday.new(options) do |faraday|
+        faraday.adapter Faraday.default_adapter
+        faraday.request :url_encoded
+      end
+    end
+
+    private
+
+    def options
+      headers = {
+        accept: 'application',
+        user_agent: "arh_archieve gem/#{ArhArchive::VERSION}"
+      }
+
+      {
+        headers: headers,
+        url: BASE_URL
+      }
+    end
+  end
+end

data/lib/arh_archive/request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ArhArchive
+  module Request
+    include ArhArchive::Connection
+
+    def get(path, params = {})
+      connection.get(path, params)
+    end
+  end
+end

data/lib/arh_archive/saver.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ArhArchive
+  class Saver
+    def initialize(response, document, page, directory_path)
+      file_name = "#{document}_#{page}.jpg"
+      file_path = File.join(directory_path, file_name)
+
+      FileUtils.mkdir_p(directory_path)
+
+      File.binwrite(file_path, response.body)
+    end
+  end
+end

data/lib/arh_archive/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ArhArchive
+  VERSION = '0.0.1.rc1'
+end

data/lib/arh_archive.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'zeitwerk'
+require 'faraday'
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+# This is a Ruby client that enables you to easily perform translations using ArhArchive API:
+#
+# client = ArhArchive.client
+# result = client.save_images(number_of_document, page_from, page_to, directory, params)
+
+module ArhArchive
+  class << self
+    # Initializes a new Client object
+    #
+    # @return [ArhArchive::Client]
+    def client
+      ArhArchive::Client.new
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: arh_archive
+version: !ruby/object:Gem::Version
+  version: 0.0.1.rc1
+platform: ruby
+authors:
+- Maksim Korelskii
+bindir: bin
+cert_chain: []
+date: 2025-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: This is a Ruby client that enables you to easily perform using ArhArchive.
+email:
+- mkorelskii@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- arh_archive.gemspec
+- lib/arh_archive.rb
+- lib/arh_archive/client.rb
+- lib/arh_archive/connection.rb
+- lib/arh_archive/request.rb
+- lib/arh_archive/saver.rb
+- lib/arh_archive/version.rb
+homepage: https://github.com/MaksimKorelskii/arh_archive
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/MaksimKorelskii/arh_archive
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.3
+specification_version: 4
+summary: Ruby interface.
+test_files: []