cloudflare_storage 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb0947aadcd4d5569d1b7dfc86ac2b10d30510d26532150cff86fe1a82edce00
-  data.tar.gz: 9ed75b05b6492d1a7519d877fec5760adc0727917363765604b1c057d4779d26
+  metadata.gz: 318cee73402c3107f230b6d46531935e6fb8bfae9a7b74ba18f6b7615683aa7a
+  data.tar.gz: ff3816282d78df06af6627cbefd8c3b428edd1ece0e58c38ef19b498a9d11b80
 SHA512:
-  metadata.gz: 9903d4d58316ac04a30099b49e08d224fd9d7a4282eb897880300d5cae37712c0ce8c2cac91a5ac5a6344a3f1961e7276ef7389e3b0639e45d2bf218b5cfcef1
-  data.tar.gz: 5ad630b82c75ba55f3b61329acff25a853bcab4c2afbe736a9ef7f0cfe47097f9a3c30f0957451fbab9cadc8b593cc215653eac33696a2b0934707baa2c207ff
+  metadata.gz: b5f4f147aa8dcce0b7d076c66b184f40d4766ee1e8cac338abb0edba332573914a8bd77ff529e501f6847d4ae621cf1ec30cf3346aafe82360e28d1d67eb2150
+  data.tar.gz: 62c39d580db6a23864869f78df1db196333e57921754066371917dc609b4155465b992cc4624ad2f4831bac627c0cff496aed60cfdf9e2928461db28cb7a46e6

data/README.md

@@ -6,11 +6,9 @@ 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'
 ```
 
@@ -43,7 +41,7 @@ end
 
 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).
+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`, then create a new git tag and push it. Github actions will take care of the rest.
 
 ## Contributing
 

data/lib/cloudflare_storage/client.rb

@@ -0,0 +1,42 @@
+require 'faraday'
+module CloudflareStorage
+  class Client
+    def initialize(account_id, namespace_id, token, connection = nil)
+      raise MissingCredentialsError, "Please configure account_id" if account_id.nil?
+      raise MissingCredentialsError, "Please configure namespace_id" if namespace_id.nil?
+      raise MissingCredentialsError, "Please configure token" if token.nil?
+
+      @conn = connection || 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 && !params.empty?
+      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/cloudflare_storage/error.rb

@@ -0,0 +1,7 @@
+module CloudflareStorage
+  class Error < StandardError
+  end
+  
+  class MissingCredentialsError < Error
+  end
+end

data/lib/{workers_kv → cloudflare_storage}/keys.rb

@@ -1,4 +1,4 @@
-module WorkersKV
+module CloudflareStorage
   class Keys < Client
 
     def initialize(client)
@@ -6,7 +6,7 @@ module WorkersKV
     end
 
     def list(prefix)
-      if prefix.present?
+      if prefix && !prefix.empty?
         @client.get("keys", { "prefix": prefix })
       else
         @client.get("keys")

data/lib/{workers_kv → cloudflare_storage}/values.rb

@@ -1,8 +1,8 @@
-module WorkersKV
+module CloudflareStorage
   class Values < Client
 
     def initialize(client)
-      @client = client
+      @client ||= client
     end
 
     # Manage Values

data/lib/cloudflare_storage/version.rb

@@ -0,0 +1,3 @@
+module CloudflareStorage
+  VERSION = '0.1.2'
+end

data/lib/cloudflare_storage.rb

@@ -1,43 +1,52 @@
 # frozen_string_literal: true
-require_relative "workers_kv/client"
-require_relative "workers_kv/values"
-require_relative "workers_kv/keys"
+require_relative "cloudflare_storage/client"
+require_relative "cloudflare_storage/values"
+require_relative "cloudflare_storage/keys"
+require_relative "cloudflare_storage/version"
+require_relative "cloudflare_storage/error"
 
 
-class CloudflareStorage
+module CloudflareStorage
   class << self
-    attr_accessor :account_id, :namespace_id, :token
+    attr_accessor :configuration
+
+    def configure(&block)
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+
+    def conn
+      raise MissingCredentialsError, "CloudflareStorage not configured" if CloudflareStorage.configuration.nil?
+      @connection ||= Client.new(
+        CloudflareStorage.configuration.account_id,
+        CloudflareStorage.configuration.namespace_id,
+        CloudflareStorage.configuration.token,
+        CloudflareStorage.configuration.connection
+      )
+    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
 
-  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
+  class Configuration
+    attr_accessor :account_id, :namespace_id, :token, :connection
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: cloudflare_storage
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
-- Lee Gillentine
+- "@geetotes"
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-04 00:00:00.000000000 Z
-dependencies: []
+date: 2025-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Library for interacting with Cloudflare Workers KV Storage and configuring
   connection from a Rails application.
 email:
@@ -24,9 +38,11 @@ files:
 - README.md
 - Rakefile
 - lib/cloudflare_storage.rb
-- lib/workers_kv/client.rb
-- lib/workers_kv/keys.rb
-- lib/workers_kv/values.rb
+- lib/cloudflare_storage/client.rb
+- lib/cloudflare_storage/error.rb
+- lib/cloudflare_storage/keys.rb
+- lib/cloudflare_storage/values.rb
+- lib/cloudflare_storage/version.rb
 - sig/cloudflare_storage.rbs
 homepage: https://github.com/geetotes/cloudflare_storage
 licenses:

data/lib/workers_kv/client.rb

@@ -1,37 +0,0 @@
-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