url_to_markdown 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2183cbb77e1eb9a58965d80e977b81698d81d5dc48ccb433d286e02dbcfa53e6
-  data.tar.gz: 30e5a87e074c00f456d67258b2ddbeed332dc6b2670e49915e356729560c0948
+  metadata.gz: 4ee86bddc38ccddc190d68aef6b7e29c0aea48d61810efad1e5b9e793dca374d
+  data.tar.gz: aebb67cdd1aff8e9156fd616964b54118d5cec0e91762b51422ada379cfd4b76
 SHA512:
-  metadata.gz: 66d0679ca3291058214204f6ac251898e7cc9fe348f3aa0ac5bf3167bb07d582180b49602191c6e023e62dfb8cc5395f8db6cdede0433fec289b926e46154e1c
-  data.tar.gz: 8e30c81de02f1360ab9e143aa21d947a0212c14ac1b0d05554e44c975a9b087d7083ebb13915390848b7530a3072eaf9f7b36747bfc6275f7703ae0a2da5f381
+  metadata.gz: 90f9c1161a277a3d6fa9e92574e8410ade755ba00b0e71867674e5ae5a3f2f8ce3245af4a68c6682d6dd8b4eba3fb734caa5f74f133f2cea5408cc2566de102f
+  data.tar.gz: b187a9e3ba8f0e1eb5f6f1007021df9b9c2ecbd800276e6a9b495e358aff131574f64753ed544516796d5fbc449c7c145b0b5d3360cec8b24a5288f95c20aed3

data/README.md

@@ -16,6 +16,14 @@ Cloudflare Browser Rendering is the default processor, but you can plug in your
 
 ## Installation
 
+Add the gem to your Gemfile:
+
+```ruby
+gem 'url_to_markdown'
+```
+
+Then install:
+
 ```bash
 bundle install
 ```
@@ -185,18 +193,24 @@ result.on_error do |error|
 end
 ```
 
-## Development
+## Contributing
 
-### Tests
+### Environment Variables
+
+Set the Cloudflare credentials before running integration or manual checks:
 
 ```bash
-bundle exec rake test
+export CLOUDFLARE_API_TOKEN="your-token"
+export CLOUDFLARE_ACCOUNT_ID="your-account-id"
 ```
 
-### Sorbet
+Check the Cloudflare Developers documentation about [finding account and zone id](https://developers.cloudflare.com/fundamentals/account/find-account-and-zone-ids/#copy-your-account-id) to get your account it. 
+Generate an API TOKEN by following [the documentation about Browser Rendering](https://developers.cloudflare.com/browser-rendering/rest-api/#before-you-begin) where you will also find the permission needed for the token. 
+
+### Tests
 
 ```bash
-bundle exec srb tc
+bundle exec rake test
 ```
 
 ### RuboCop

data/lib/url_to_markdown/cloudflare/client.rb

@@ -17,7 +17,8 @@ class UrlToMarkdown
         validate_credentials!
       end
 
-      def markdown(url: nil, html: nil, wait_for_selector: nil, wait_for_timeout_in_milliseconds: nil, cache_ttl: nil)
+      def markdown(url: nil, html: nil, wait_for_selector: nil, wait_for_timeout_in_milliseconds: nil, cache_ttl: nil,
+                   actions: nil)
         validate_payload!(url: url, html: html)
 
         response = connection.post("accounts/#{@account_id}/browser-rendering/markdown") do |request|
@@ -29,7 +30,8 @@ class UrlToMarkdown
                                          html: html,
                                          wait_for_selector: wait_for_selector,
                                          wait_for_timeout_in_milliseconds: wait_for_timeout_in_milliseconds,
-                                         cache_ttl: cache_ttl
+                                         cache_ttl: cache_ttl,
+                                         actions: actions
                                        ))
         end
 
@@ -56,7 +58,7 @@ class UrlToMarkdown
         raise UrlToMarkdown::ValidationError.new(nil, "Provide a URL or HTML")
       end
 
-      def build_payload(url:, html:, wait_for_selector:, wait_for_timeout_in_milliseconds:, cache_ttl:)
+      def build_payload(url:, html:, wait_for_selector:, wait_for_timeout_in_milliseconds:, cache_ttl:, actions: nil)
         payload = {}
         payload[:url] = url if url
         payload[:html] = html if html
@@ -66,6 +68,7 @@ class UrlToMarkdown
             wait_for_timeout_in_milliseconds
         end
         payload[:cache_ttl] = cache_ttl if cache_ttl
+        payload[:actions] = actions if actions&.any?
         payload
       end
 

data/lib/url_to_markdown/cloudflare/processor.rb

@@ -15,9 +15,9 @@ class UrlToMarkdown
         )
       end
 
-      def convert(url)
+      def convert(url, actions: nil)
         validate_url!(url)
-        @client.markdown(url: url)
+        @client.markdown(url: url, actions: actions)
       end
 
       private

data/lib/url_to_markdown/configuration.rb

@@ -5,7 +5,7 @@ require "logger"
 class UrlToMarkdown
   class Configuration
     attr_accessor :cloudflare_api_token, :cloudflare_account_id, :cloudflare_timeout_ms, :cloudflare_cache_ttl,
-                  :logger, :default_processor
+                  :logger, :default_processor, :default_actions
 
     def initialize
       @cloudflare_api_token = ENV.fetch("CLOUDFLARE_API_TOKEN", nil)
@@ -14,6 +14,7 @@ class UrlToMarkdown
       @cloudflare_cache_ttl = 5
       @logger = Logger.new($stdout)
       @default_processor = UrlToMarkdown::Cloudflare::Processor
+      @default_actions = nil
     end
 
     def cloudflare_api_token!

data/lib/url_to_markdown/processor.rb

@@ -7,7 +7,7 @@ class UrlToMarkdown
       @cache_store = cache_store
     end
 
-    def convert(_url)
+    def convert(_url, actions: nil)
       raise NotImplementedError, "Implement in subclass"
     end
   end

data/lib/url_to_markdown/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class UrlToMarkdown
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/url_to_markdown.rb

@@ -8,11 +8,12 @@ loader.inflector.inflect("errors" => "Error", "pstore" => "PStore")
 loader.setup
 
 class UrlToMarkdown
-  def initialize(url:, processor: nil, logger: nil, cache_store: nil)
+  def initialize(url:, processor: nil, logger: nil, cache_store: nil, actions: nil)
     @url = url
     @processor_class = processor || self.class.configuration.default_processor
     @logger = logger || self.class.configuration.logger
     @cache_store = cache_store
+    @actions = actions || self.class.configuration.default_actions
   end
 
   def convert
@@ -27,7 +28,7 @@ class UrlToMarkdown
     end
 
     processor = @processor_class.new(logger: @logger, cache_store: @cache_store)
-    result = processor.convert(@url)
+    result = processor.convert(@url, actions: @actions)
 
     @cache_store.store!(@url, result.payload) if @cache_store && result.respond_to?(:success?) && result.success?
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: url_to_markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Lucian Ghinda
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Convert URLs to Markdown via Cloudflare Browser Rendering
 test_files: []