cloudflare_storage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb0947aadcd4d5569d1b7dfc86ac2b10d30510d26532150cff86fe1a82edce00
+  data.tar.gz: 9ed75b05b6492d1a7519d877fec5760adc0727917363765604b1c057d4779d26
+SHA512:
+  metadata.gz: 9903d4d58316ac04a30099b49e08d224fd9d7a4282eb897880300d5cae37712c0ce8c2cac91a5ac5a6344a3f1961e7276ef7389e3b0639e45d2bf218b5cfcef1
+  data.tar.gz: 5ad630b82c75ba55f3b61329acff25a853bcab4c2afbe736a9ef7f0cfe47097f9a3c30f0957451fbab9cadc8b593cc215653eac33696a2b0934707baa2c207ff

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-02-04
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Lee Gillentine
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# CloudflareStorage
+
+CloudflareStorage is a simple gem for interacting with the Cloudflare Workers KV Storage from a Rails application.
+
+It was designed to let you get started with minimal configuration.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Add this line to your application's Gemfile:
+
+````
+gem 'cloudflare_storage'
+```
+
+And then run:
+
+```bash
+bundle
+```
+
+Or install it yourself:
+
+```bash
+gem install cloudflare_storage 
+```
+
+## Usage
+
+Configure credentials with an initializer. For example:
+```ruby
+# config/initializers/cloudflare_storage.rb
+CloudflareStorage.configure do |config|
+    config.account_id = Rails.application.credentials.cloudflare.account_id
+    config.namespace_id = Rails.application.credentials.cloudflare.namespace_id
+    config.token = Rails.application.credentials.cloudflare.token
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/geetotes/cloudflare_storage.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Alternatives
+
+There are other gems out there that encompass the whole of the Cloudflare API. You should look to those if you're planning on using more than just Workers KV storage in your project.
+
+* [Cloudflare](https://github.com/socketry/cloudflare)
+* [Rubyflare](https://github.com/trev/rubyflare)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/cloudflare_storage.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+require_relative "workers_kv/client"
+require_relative "workers_kv/values"
+require_relative "workers_kv/keys"
+
+
+class CloudflareStorage
+  class << self
+    attr_accessor :account_id, :namespace_id, :token
+  end
+
+  def self.configure(&block)
+    yield self
+  end
+
+  def conn
+    @connection ||= WorkersKV::Client.new(
+      CloudflareStorage.account_id,
+      CloudflareStorage.namespace_id,
+      CloudflareStorage.token
+    )
+  end
+
+  def list(prefix = nil)
+    resp = conn.keys.list(prefix)
+    resp.body.dig("result").pluck("name")
+  end
+
+  def read(key)
+    resp = conn.values.read(key)
+    resp.body
+  end
+
+  def write(key, value)
+    resp = conn.values.write(key, value)
+    resp.body
+  end
+
+  def delete(key)
+    resp = conn.values.delete(key)
+    resp.body
+  end
+end

data/lib/workers_kv/client.rb

@@ -0,0 +1,37 @@
+module WorkersKV
+  class Client
+    def initialize(account_id, namespace_id, token)
+      @conn = Faraday.new(url: "https://api.cloudflare.com/client/v4/accounts/#{account_id}/storage/kv/namespaces/#{namespace_id}/" ) do |builder|
+        builder.request :authorization, "Bearer", token
+        builder.request :json
+        builder.response :json
+        builder.response :raise_error
+      end
+    end
+
+    def values
+      @values ||= Values.new(self)
+    end
+    
+    def keys
+      @keys ||= Keys.new(self)
+    end
+
+    protected
+    def get(path, params = nil)
+      @conn.get path do |req|
+        req.params = params if params.present?
+      end
+    end
+
+    def put(path, body)
+      @conn.put path do |req|
+        req.body = body
+      end
+    end
+
+    def conn_delete(path)
+      @conn.delete path
+    end
+  end
+end

data/lib/workers_kv/keys.rb

@@ -0,0 +1,16 @@
+module WorkersKV
+  class Keys < Client
+
+    def initialize(client)
+      @client ||= client
+    end
+
+    def list(prefix)
+      if prefix.present?
+        @client.get("keys", { "prefix": prefix })
+      else
+        @client.get("keys")
+      end
+    end
+  end
+end

data/lib/workers_kv/values.rb

@@ -0,0 +1,21 @@
+module WorkersKV
+  class Values < Client
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Manage Values
+    def write(key, value)
+      @client.put("values/#{key}", value)
+    end
+
+    def read(key)
+      @client.get("values/#{key}")
+    end
+
+    def delete(key)
+      @client.conn_delete("values/#{key}")
+    end
+  end
+end

data/sig/cloudflare_storage.rbs

@@ -0,0 +1,4 @@
+module CloudflareStorage
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: cloudflare_storage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lee Gillentine
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-02-04 00:00:00.000000000 Z
+dependencies: []
+description: Library for interacting with Cloudflare Workers KV Storage and configuring
+  connection from a Rails application.
+email:
+- lee@fishburd.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/cloudflare_storage.rb
+- lib/workers_kv/client.rb
+- lib/workers_kv/keys.rb
+- lib/workers_kv/values.rb
+- sig/cloudflare_storage.rbs
+homepage: https://github.com/geetotes/cloudflare_storage
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/geetotes/cloudflare_storage
+  source_code_uri: https://github.com/geetotes/cloudflare_storage
+  changelog_uri: https://github.com/geetotes/cloudflare_storage/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Library for interacting with CLoudflare Workers KV
+test_files: []