cloudflared 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a70d9d3f9d8e49c536fb019c0bc5052e4cc900d65cd1a5f616a44a56d7c0636f
-  data.tar.gz: e9351f030dc93db44391dd0685c3580a9269a0af63912da46a4051a710df945e
+  metadata.gz: 5d9bb494988767889b7a6389bfb73ab51cbbe0f0ff62ab769db00c2810fa47fc
+  data.tar.gz: 074b5ddbe705f87dfd346147c9a971842d649bb193f4aabd23a8db2217be5864
 SHA512:
-  metadata.gz: 8e9d5fe29cdae2bb50acd520a58a7357bcf5b57075524a3034869cbe92424eeca0994c99680f10c275818dcda9d7b40a1d26abdb66ce612e9a4b9660a353547a
-  data.tar.gz: d15e523393ce50cc5e6395e34ac8b4b06c22301268f0dcd0c9b497e79f84ed8cd22463a6f3d6cf29966dba3de66d0d936061cc1416f5b487d363cb230f03bbd2
+  metadata.gz: 8729793b880b6b03e1214493bdb895f2d7c7839c99e8df38669effe4592bd6aae13416ecdd541a21fa5172e3a8c9a48fc8830171e60a40c6dd83a019e9abcb13
+  data.tar.gz: 8a3987f4dc99b8bc29558884adffeb05165ef9e3f933bdf341838e16036537ff09869cc4c2df9f4dc7650c65e682ff3c865669acc2f8146662903922446de165

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cloudflared (0.1.3)
+    cloudflared (0.1.0)
       faraday (~> 2.1.0)
       faraday-multipart (~> 1.0, >= 1.0.3)
       marcel (~> 1.0, >= 1.0.2)

data/README.md

@@ -23,23 +23,51 @@ Or install it yourself as:
 
     $ gem install cloudflared
 
+## Setup 
+
+You will need the following keys from your Cloudflare account: 
+
+
 ## Usage
 
 Working with Cloudflare Images:
 
 ```ruby
-client = Cloudflared::Client.new(api_key: "foo", account_id: "bar", images_hash: "baz")
+client = Cloudflared::Client.new(api_key: "foo", account_id: "bar", images_hash: "baz", images_default_hash: "foobar")
 client.images.delete(file_id: "1234")
 client.images.details(file_id: "1234")
 client.images.direct_upload_url
 client.images.download(file_id: "1234")
 client.images.list
-client.images.signed_url(file_id: "1234", key: "default_key", expiry_seconds: 60 * 15)
+client.images.signed_url(file_id: "1234", expiry_seconds: 60 * 15)
 client.images.stats
 client.images.update(file_id: "1234", requireSignedURLs: true)
 client.images.upload(file: "/path/to/file", requireSignedURLs: true)
 ```
 
+#### Rails and Pre-configured client settings
+
+If you're using this in rails (or want to pre-configure settings), you can pre-configure the client settings via an initializer by adding the following:
+
+```ruby
+# config/initializers/cloudflared.rb
+ 
+Cloudflared.configure do |config|
+  config.api_key = "key"
+  config.account_id = "key"
+  config.images_hash = "key"
+  config.images_default_key = "key"
+  config.adapter = Faraday.default_adapter  # optional, defaults to Faraday.default_adapter
+end
+```
+
+If pre-configured, the client is available via the following shortcut: 
+
+```ruby
+client = Cloudflared.client
+client.images.details(file_id: "1234")
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/console

@@ -11,7 +11,11 @@ require "cloudflared"
 # require "pry"
 # Pry.start
 
-@client = Cloudflared::Client.new(account_id: ENV["CLOUDFLARE_IMAGES_ACCOUNT_ID"], api_key: ENV["CLOUDFLARE_IMAGES_API_KEY"])
+@client = Cloudflared::Client.new(
+  account_id: ENV["CLOUDFLARE_IMAGES_ACCOUNT_ID"],
+  api_key: ENV["CLOUDFLARE_IMAGES_API_KEY"],
+  images_hash: ENV["CLOUDFLARE_IMAGES_HASH"],
+  images_default_key: ENV["CLOUDFLARE_IMAGES_DEFAULT_KEY"])
 
 require "irb"
 IRB.start(__FILE__)

data/lib/cloudflared/client.rb

@@ -4,7 +4,7 @@ module Cloudflared
   class Client
     BASE_URL = "https://api.cloudflare.com/client/v4/accounts"
 
-    attr_reader :api_key, :account_id, :adapter, :images_hash
+    attr_reader :api_key, :account_id, :adapter, :images_hash, :images_default_key, :stubs
 
     # Initializes a new Cloudflare client.
     #
@@ -17,6 +17,9 @@ module Cloudflared
     # @!attribute images_hash
     #   @return [String] The Cloudflare images hash found on the images dashboard. This is used for image delivery urls.
     #
+    # @!attribute images_default_key
+    #   @return [String] The default key for signing private images
+    #
     # @!attribute adapter
     #   @return [Symbol] The Faraday adapter to use
     #
@@ -24,11 +27,12 @@ module Cloudflared
     #   @return [Symbol] Stubs for use in testing
     #
     # @return [Cloudflared]
-    def initialize(api_key:, account_id:, images_hash: nil, adapter: Faraday.default_adapter, stubs: nil)
+    def initialize(api_key:, account_id:, images_hash:, images_default_key:, adapter: Faraday.default_adapter, stubs: nil)
       @api_key = api_key
       @adapter = adapter
       @account_id = account_id
       @images_hash = images_hash
+      @images_default_key = images_default_key
       @stubs = stubs
     end
 

data/lib/cloudflared/config.rb

@@ -0,0 +1,14 @@
+module Cloudflared
+  # Class used to initialize configuration object.
+  class Config
+    attr_accessor :api_key
+    attr_accessor :account_id
+    attr_accessor :images_hash
+    attr_accessor :images_default_key
+    attr_accessor :adapter
+    attr_accessor :stubs
+
+    def initialize
+    end
+  end
+end

data/lib/cloudflared/resources/images.rb

@@ -34,13 +34,13 @@ module Cloudflared
       "#{IMAGE_DELIVERY_URL}/#{@client.images_hash}/#{path}"
     end
 
-    def signed_url(path, key:, expiry_seconds: FIFTEEN_MINUTES)
+    def signed_url(path, expiry_seconds: FIFTEEN_MINUTES)
       # The path uses the image + the file_id (and a variant if passed through)
       path = path[1..] if path[0] == "/"
       path = "#{@client.images_hash}/#{path}"
 
       # Calculate the hexdigest with the  leading slash
-      sig = OpenSSL::HMAC.hexdigest("SHA256", key, "/#{path}")
+      sig = OpenSSL::HMAC.hexdigest("SHA256", @client.images_default_key, "/#{path}")
 
       # Calculate the seconds since the epoch in the future
       exp = Time.new.to_i + expiry_seconds

data/lib/cloudflared/version.rb

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

data/lib/cloudflared.rb

@@ -4,11 +4,43 @@ require_relative "cloudflared/version"
 
 module Cloudflared
   autoload :Client, "cloudflared/client"
-  autoload :Error, "cloudflared/error"
   autoload :Collection, "cloudflared/collection"
+  autoload :Config, "cloudflared/config"
+  autoload :Error, "cloudflared/error"
   autoload :Object, "cloudflared/object"
   autoload :Resource, "cloudflared/resource"
 
   autoload :Image, "cloudflared/objects/image"
   autoload :ImagesResource, "cloudflared/resources/images"
+
+  # Returns Cloudflared's configuration object.
+  def self.config
+    @config ||= Cloudflared::Config.new
+  end
+
+  # Creates a client instance with pre-configured values
+  def self.client
+    Cloudflared::Client.new(
+      api_key: config.api_key,
+      account_id: config.account_id,
+      images_hash: config.images_hash,
+      images_default_key: config.images_default_key,
+      adapter: config.adapter || Faraday.default_adapter
+    )
+  end
+
+  # Lets you set global configuration options.
+  #
+  # All available options and their defaults are in the example below:
+  # @example Initializer for Rails
+  #   Cloudflared.configure do |config|
+  #     config.api_key      = "key"
+  #     config.account_id   = "secret"
+  #     config.images_hash  = "hash"
+  #     config.images_default_key  = "key"
+  #     config.adapter      = Faraday.default_adapter
+  #   end
+  def self.configure(&block)
+    yield(config) if block
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudflared
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - devynbit
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-31 00:00:00.000000000 Z
+date: 2022-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -87,6 +87,7 @@ files:
 - lib/cloudflared.rb
 - lib/cloudflared/client.rb
 - lib/cloudflared/collection.rb
+- lib/cloudflared/config.rb
 - lib/cloudflared/error.rb
 - lib/cloudflared/object.rb
 - lib/cloudflared/objects/image.rb