coelacanth 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b51ba18dce6ea95e76c1fc67b267da6c2b8a688c5e40b402f68e2b688175485e
-  data.tar.gz: 01cd7b7e605ac2524e581d5b97bd3367047a314f0337baec028eb8a4d6897615
+  metadata.gz: e367168c49a2f7f9b99dc3cca36a403aabc49c12b2ce7eed101d48846bc9d848
+  data.tar.gz: 46576f957bc34f8edc74638b2f5c7e26726726237d17f180fc8afe5f942bcaf8
 SHA512:
-  metadata.gz: a568228270b45bb3e4ffa7da6889f44d232b10bdafbe6fd63c11a9fc65ca399feeeb56cdc2120a8ed680bcdf3f43c0df2ddae3af7c05093ad9a0468ff30e66f8
-  data.tar.gz: b9bcff90f51c0186a6bc419fd36d70657a2ac1df8d6cbd090bd9c13106031e250c7744fdc442021232fddbb58fcf4b48759e5f2ffa0334f21479c547158c0521
+  metadata.gz: e151df698b9e1c36e74c3a1228b45f81b0eeda2295bdc87a345e3bb04167d83f7a66cf2978256f2fe0f1cca90b4a34234d06c36087221693597709dadce2a86b
+  data.tar.gz: '03916c2ca92146938606668442fa06879e2847aa4fceb498d811ba5f3ddacac5b7fdb1072a29e6fea4a659d09d874218963ef50c96238e38898bab93e8e27d80'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    coelacanth (0.1.0)
+    coelacanth (0.1.3)
 
 GEM
   remote: https://rubygems.org/
@@ -73,4 +73,4 @@ DEPENDENCIES
   rubocop (~> 1.21)
 
 BUNDLED WITH
-   2.5.14
+   2.5.7

data/README.md

@@ -1,9 +1,8 @@
 # coelacanth
 
 [![Gem Version](https://badge.fury.io/rb/coelacanth.svg)](https://badge.fury.io/rb/coelacanth)
-[![Build Status](https://github.com/slidict/coelacanth/actions/workflows/test.yml/badge.svg)](https://github.com/slidict/coelacanth/actions)
+[![Build Status](https://github.com/slidict/coelacanth/actions/workflows/main.yml/badge.svg)](https://github.com/slidict/coelacanth/actions)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
-[![Maintainability](https://api.codeclimate.com/v1/badges/123abc456def/maintainability)](https://codeclimate.com/github/slidict/coelacanth/maintainability)
 
 `coelacanth` is a gem that allows you to parse and analyze web pages, extracting key statistics and information for further use within your projects.
 
@@ -51,12 +50,33 @@ Then, you can easily parse and extract information from a web page like this:
 
 ```ruby
 url = "https://example.com"
-stats = Coelacanth.analyze(url)
+stats = Coelacanth.analyze(url) # Not yet implement
 ```
 
 ## Features
 - More features coming soon!
 
+## Commit Message Guidelines
+
+To ensure consistency and facilitate automatic updates to the `CHANGELOG.md`, please follow the [Conventional Commits](https://www.conventionalcommits.org/) specification when creating commit messages. This helps maintain a clear and structured commit history.
+
+When submitting a Pull Request (PR), make sure your commits adhere to these guidelines.
+
+### Example of Conventional Commit Messages:
+
+- `feat: add new feature for parsing web pages`
+- `fix: resolve issue with URL redirection`
+- `docs: update README with usage instructions`
+- `chore: update dependencies`
+- `build: update build configuration`
+- `ci: update CI pipeline`
+- `style: fix code style issues`
+- `refactor: refactor code for better readability`
+- `perf: improve performance of data processing`
+- `test: add new tests for URL parsing module`
+
+By following these guidelines, you help ensure that our project's commit history is easy to navigate and that versioning and release notes are generated correctly.
+
 ## Contributing
 Bug reports and pull requests are welcome on GitHub at https://github.com/slidict/coelacanth. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
 

data/config/coelacanth.yml

@@ -1,5 +1,11 @@
 development: &development
   use_remote_client: false
+  remote_client:
+    ws_url: "ws://chrome:3000/chrome"
+    timeout: 10 # seconds
+    headers:
+      Authorization: "Bearer 1234567890"
+      User-Agent: "Coelacanth Chrome Extension"
 test:
   <<: *development
 production:

data/lib/coelacanth/client.rb

@@ -1,9 +1,14 @@
 # frozen_string_literal: true
+
 require "ferrum"
 
 module Coelacanth
   # Coelacanth::Client
   class Client
+    def initialize
+      @config = Configure.new
+    end
+
     def valid_url?(url)
       uri = URI.parse(url)
       uri.is_a?(URI::HTTP) || uri.is_a?(URI::HTTPS)
@@ -18,7 +23,7 @@ module Coelacanth
       response = get_response(url)
 
       case response
-      when Net::HTTPSuccess then URI.parse(url)
+      when Net::HTTPSuccess then url
       when Net::HTTPRedirection then resolve_redirect(response["location"], limit - 1)
       else
         raise Coelacanth::RedirectError
@@ -26,21 +31,26 @@ module Coelacanth
     end
 
     def get_response(url)
-      if Configure.new.read("use_remote_client")
+      if @config.read("use_remote_client")
         remote_client.goto(url)
         remote_client.body
       else
-        Net::HTTP.get_response(URI.parse(url))
+        Net::HTTP.get_response(url)
       end
     end
 
     private
 
     def remote_client
-      @remote_client ||= Ferrum::Browser.new(
-        ws_url: "ws://chrome:3000/chrome",
-        timeout: 20
-      ).create_page
+      if @remote_client.nil?
+        headers = @config.read("remote_client.headers")
+        @remote_client = Ferrum::Browser.new(
+          ws_url: @config.read("remote_client.ws_url"),
+          timeout: @config.read("remote_client.timeout")
+        ).create_page
+        @remote_client.headers.set(headers) unless headers.empty?
+      end
+      @remote_client
     end
   end
 end

data/lib/coelacanth/configure.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "yaml"
 require "erb"
 
@@ -8,8 +9,13 @@ module Coelacanth
     CONFIG_PATH = "config/coelacanth.yml"
 
     def read(key)
+      return yaml[key] unless key.include?(".")
+
+      key.split(".").reduce(yaml) { |hash, k| hash[k] }
+    end
+
+    def yaml
       @yaml ||= YAML.unsafe_load(ERB.new(File.read(file)).result)[env]
-      @yaml[key]
     end
 
     private

data/lib/coelacanth/version.rb

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

data/lib/coelacanth.rb

@@ -11,7 +11,8 @@ module Coelacanth
   class RedirectError < StandardError; end
   class DeepRedirectError < StandardError; end
 
-  def self.analyze(_url)
+  def self.analyze(url)
+    Client.get_response(url)
     {
       todo: "implement me"
     }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coelacanth
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Yusuke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-24 00:00:00.000000000 Z
+date: 2024-08-28 00:00:00.000000000 Z
 dependencies: []
 description: |
   coelacanth is a gem that allows you to easily parse and analyze web pages,
@@ -29,8 +29,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- changelog-ci-config.yml
-- coelacanth.gemspec
 - compose.yml
 - config/coelacanth.yml
 - lib/coelacanth.rb
@@ -41,7 +39,6 @@ homepage: https://github.com/slidict/coelacanth
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/slidict/coelacanth
   source_code_uri: https://github.com/slidict/coelacanth
   changelog_uri: https://github.com/slidict/coelacanth/blob/main/CHANGELOG.md
@@ -53,14 +50,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.3'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.7
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: A gem for analyzing and extracting statistics from web pages.

data/changelog-ci-config.yml

@@ -1,29 +0,0 @@
-changelog_type: 'commit_message' # or 'pull_request'
-header_prefix: 'Version:'
-commit_changelog: true
-comment_changelog: true
-include_unlabeled_changes: true
-unlabeled_group_title: 'Unlabeled Changes'
-pull_request_title_regex: '^Release'
-version_regex: 'v?([0-9]{1,2})+[.]+([0-9]{1,2})+[.]+([0-9]{1,2})\s\(\d{1,2}-\d{1,2}-\d{4}\)'
-exclude_labels:
-  - bot
-  - dependabot
-  - ci
-group_config:
-  - title: Bug Fixes
-    labels:
-      - bug
-      - bugfix
-  - title: Code Improvements
-    labels:
-      - improvements
-      - enhancement
-  - title: New Features
-    labels:
-      - feature
-  - title: Documentation Updates
-    labels:
-      - docs
-      - documentation
-      - doc

data/coelacanth.gemspec

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/coelacanth/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "coelacanth"
-  spec.version       = Coelacanth::VERSION
-  spec.authors       = ["Yusuke"]
-  spec.email         = ["yusuke@slidict.io"]
-
-  spec.summary       = "A gem for analyzing and extracting statistics from web pages."
-  spec.description   = <<~DESC
-    coelacanth is a gem that allows you to easily parse and analyze web pages,
-    extracting key statistics and information for further use in various projects."
-  DESC
-  spec.homepage      = "https://github.com/slidict/coelacanth"
-  spec.license       = "MIT"
-  spec.required_ruby_version = ">= 3.3"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-  spec.metadata["homepage_uri"]      = spec.homepage
-  spec.metadata["source_code_uri"]   = "https://github.com/slidict/coelacanth"
-  spec.metadata["changelog_uri"]     = "https://github.com/slidict/coelacanth/blob/main/CHANGELOG.md"
-
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
-    end
-  end
-
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "nokogiri", "~> 1.12"
-end