bunny_cdn 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81a013ab55bd42ba7283dff2033ec705d9b781e22421f6deb25988a58c1dc41c
-  data.tar.gz: 43e3dc3bbd71991387c2a02cb344c0443702c8d5df7602585bd559bb7f47630c
+  metadata.gz: 7c39cfb456030b3e4c3d329031894dbb9280ed683857cc87c9415ffaf9af5a6b
+  data.tar.gz: 1e9d967f43084c2c95fff77d546e8eb7662204c2c81107e58583fa5a9e3c14fe
 SHA512:
-  metadata.gz: d01c00921af2b6f91fcb59683dd01baf01e892dd28255b7dd50c402da991614efd34a0b9c44313aad09284167333c450ff80c1fb01c84447347c450fdc584312
-  data.tar.gz: 30d68d2eb8c558d3765dd7703e02355fff2a0aa86bf84ffe94733a6d46f49cec2d3f6278cd99e661fcc49b0ae48df92cef4ba66eda4627b876a785aee9f00270
+  metadata.gz: 5eef510c1c3ac8e9faaaef962e22659d36e677d3f5f3845419279a7ab883d58b14aa9dec2fbd5c750a5ab8dab6261ba85bf12c6090921127e15dc94279d96cb9
+  data.tar.gz: 3427d6dd04a628fac91c642c62a26c2627ae9ee7fb14f659e37c80057c28795fcbd72c012e52c866df6398e9d6b8e33506869195d1a7f25cb37d9825e2914ded

data/README.md

@@ -1,4 +1,6 @@
+[![Gem Version](https://badge.fury.io/rb/bunny_cdn.svg)](https://badge.fury.io/rb/bunny_cdn)
 [![Codeship Status for brandon-meeks/bunny_cdn](https://app.codeship.com/projects/7f94a660-529a-0138-70bd-36e3badc0e07/status?branch=master)](https://app.codeship.com/projects/390509)
+[![Maintainability](https://api.codeclimate.com/v1/badges/2cc8e5b9529c32d7473f/maintainability)](https://codeclimate.com/github/brandon-meeks/bunny_cdn/maintainability)
 
 # BunnyCdn
 
@@ -32,22 +34,24 @@ Create the initializer `config/initializers/bunny_cdn.rb` and set the configurat
 BunnyCdn.configure do |config|
     config.apiKey = # The API key for your BunnyCDN account
     config.storageZone = # The storage zone you want to work with
+    config.region = # the region of the storage zone. Options are 'eu' for Falkenstein, 'ny' for New York, 'la' for Los Angeles, or 'sg' for Asia
     config.accessKey = # The password for your storage zone
 end
 ```
 
-### General
+### File Uploads
 
-To use in your ruby project, simply `require "bunny_cdn"` and set it's configuration.
+New to v1.2.0, there are now two methods for handling file uploads. 
 
+To upload a file from a file input on a form, simply use 
 ```ruby
-BunnyCdn.configure do |config|
-    config.apiKey = # The API key for your BunnyCDN account
-    config.storageZone = # The storage zone you want to work with
-    config.accessKey = # The password for your storage zone
-end
+BunnyCdn::Storage.uploadFormFile(path, file)
 ```
 
+To upload a file to BunnyCDN that already exists on the system, or to upload a file as a secondary option to storing it on the system use
+```ruby
+BunnyCdn::Storage.uploadFile(path, file)
+```
 ## 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.

data/bunny_cdn.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/brandon-meeks/bunny_cdn_gem"
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  spec.metadata["changelog_uri"] = "https://github.com/brandon-meeks/bunny_cdn/releases"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -32,7 +32,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'json', '~> 2.3'
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.3", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "webmock", '~> 3.8', '>= 3.8.3'
+
+  spec.required_ruby_version = '>= 2.0.1'
 end

data/lib/bunny_cdn/configuration.rb

@@ -1,9 +1,11 @@
 module BunnyCdn
     class Configuration
-        attr_accessor :storageZone, :accessKey, :apiKey
+        attr_accessor :storageZone, :region, :accessKey, :apiKey
 
+        # Sets the configuration variables upon calling BunnyCdn::Configuration.new
         def initialize
             @storageZone = nil
+            @region = nil # Options are: eu, ny, la or sg (Asia)
             @accessKey = nil
             @apiKey = nil
         end
@@ -13,7 +15,6 @@ module BunnyCdn
         @configuration ||= Configuration.new
     end
 
-    # Set BunnyCdn's configuration
     def self.configuration=(config)
         @configuration = config
     end

data/lib/bunny_cdn/pullzone.rb

@@ -1,12 +1,16 @@
 module BunnyCdn
   class Pullzone
 
-    BASE_URL = 'https://bunnycdn.com/api/pullzone'
+    RestClient.log = STDOUT # enables RestClient logging
 
+    BASE_URL = 'https://bunnycdn.com/api/pullzone' # URL to for BunnyCDN's Pullzone API
+
+    # Sets the apiKey to that in configuration
     def self.apiKey
       @apiKey = BunnyCdn.configuration.apiKey
     end
 
+    # Sets the necessary headers to make requests to the BunnyCDN API
     def self.headers
       {
         :accesskey => apiKey,
@@ -15,6 +19,7 @@ module BunnyCdn
       }
     end
 
+    # Gets all Pull Zones from BunnyCDN
     def self.getAllPullzones
       begin
         response = RestClient.get(BASE_URL, headers)
@@ -24,6 +29,11 @@ module BunnyCdn
       return response
     end
 
+    # Creates a new pullzone
+    # Params:
+    # +name+:: the name of the new Pull Zone
+    # +type+:: the pricing type of the pull zone you wish to add. 0 = Standard, 1 = High Volume
+    # originURL+:: the origin URL where the pull zone files are pulled from.
     def self.createPullzone(name, type = 0, originUrl)
       values = {
         :name => name,
@@ -38,6 +48,9 @@ module BunnyCdn
       return response
     end
 
+    # Gets the details of the pull zone using the given ID
+    # Params:
+    # +id+:: the ID of the Pull Zone to return
     def self.getSinglePullzone(id)
       begin
         response = RestClient.get("#{BASE_URL}/#{id}", headers)
@@ -47,6 +60,9 @@ module BunnyCdn
       return response
     end
 
+    # Deletes the pull zone using the given ID
+    # Params:
+    # +id+:: the ID of the Pull Zone to delete
     def self.deletePullzone(id)
       begin
         response = RestClient.delete("#{BASE_URL}/#{id}", headers)
@@ -56,6 +72,9 @@ module BunnyCdn
       return response
     end
 
+    # Purges the cache for the Pull Zone using the given ID
+    # Params:
+    # +id+:: the ID of the zone which should have the cache purged
     def self.purgeCache(id)
       begin
         response = RestClient.post("#{BASE_URL}/#{id}/purgeCache", {}.to_json, headers)

data/lib/bunny_cdn/storage.rb

@@ -1,44 +1,110 @@
 module BunnyCdn
   class Storage
+    
+    RestClient.log = STDOUT # enables RestClient logging
 
-    BASE_URL = 'https://storage.bunnycdn.com'
-
+    # Sets the storage zone as set in configuration
     def self.storageZone
       BunnyCdn.configuration.storageZone
     end
 
+    # Sets the proper URL based on the region set in configuration
+    def self.set_region_url
+      case BunnyCdn.configuration.region
+      when nil || 'eu'
+        'https://storage.bunnycdn.com'
+      when 'ny'
+        'https://ny.storage.bunnycdn.com'
+      when 'la'
+        'https://la.storage.bunnycdn.com'
+      when 'sg'
+        'https://sg.storage.bunnycdn.com'
+      end
+    end
+    
+    # Sets the apiKey to that in configuration
     def self.apiKey
       BunnyCdn.configuration.accessKey
     end
 
+    # Sets the necessary headers to make requests to the BunnyCDN API
     def self.headers
       {
         :accesskey => apiKey
       }
     end
 
+    # Gets all the files from the storage zone
+    # Params:
+    # +path+:: desired path to get files
     def self.getZoneFiles(path= '')
-      response = RestClient.get("#{BASE_URL}/#{storageZone}/#{path}", headers)
+      begin
+        response = RestClient.get("#{set_region_url}/#{storageZone}/#{path}", headers)
+      rescue RestClient::ExceptionWithResponse => exception
+        return exception
+      end
       return response.body
     end
 
+    # Gets a single file from the storage zone
+    # Params:
+    # +path+:: desired path to get file
+    # +file+:: specific file to get from storage zone
     def self.getFile(path= '', file)
-      response = RestClient.get("#{BASE_URL}/#{storageZone}/#{path}/#{file}", headers)
+      begin
+        response = RestClient.get("#{set_region_url}/#{storageZone}/#{path}/#{file}", headers)
+      rescue RestClient::ExceptionWithResponse => exception
+        return exception
+      end
       return response.body
     end
 
+    # Uploads a file on the system to the storage zone
+    # Params:
+    # +path+:: desired path to upload file
+    # +file+:: specific file to upload to storage zone
     def self.uploadFile(path= '', file)
       fileName = File.basename(file)
       headers = {
         :accessKey => apiKey,
         :checksum => ''
       }
-      response = RestClient.put("#{BASE_URL}/#{storageZone}/#{path}/#{fileName}", File.read(file), headers)
+      begin
+        response = RestClient.put("#{set_region_url}/#{storageZone}/#{path}/#{fileName}", File.read(file), headers)
+      rescue RestClient::ExceptionWithResponse => exception
+        return exception
+      end
+      return response.body
+    end
+
+    # Uploads a file from a file input to the storage zone
+    # Params:
+    # +path+:: desired path to upload file
+    # +file+:: specific file to upload to storage zone
+    def self.uploadFormFile(path= '', file)
+      fileName = file.original_filename
+      headers = {
+        :accessKey => apiKey,
+        :checksum => ''
+      }
+      begin
+        response = RestClient.put("#{set_region_url}/#{storageZone}/#{path}/#{fileName}", File.read(file.tempfile), headers)
+      rescue RestClient::ExceptionWithResponse => exception
+        return exception
+      end
       return response.body
     end
 
+    # Deletes a file from the storage zone
+    # Params:
+    # +path+:: path to delete file from
+    # +file+:: specific file to delete from storage zone
     def self.deleteFile(path= '', file)
-      response = RestClient.delete("#{BASE_URL}/#{storageZone}/#{path}/#{file}", headers)
+      begin
+        response = RestClient.delete("#{set_region_url}/#{storageZone}/#{path}/#{file}", headers)
+      rescue RestClient::ExceptionWithResponse => exception
+        return exception
+      end
       return response.body
     end
 

data/lib/bunny_cdn/version.rb

@@ -1,3 +1,3 @@
 module BunnyCdn
-  VERSION = "1.0.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bunny_cdn
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Brandon Meeks
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-09 00:00:00.000000000 Z
+date: 2021-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -58,14 +58,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +134,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/brandon-meeks/bunny_cdn_gem
   source_code_uri: https://github.com/brandon-meeks/bunny_cdn_gem
+  changelog_uri: https://github.com/brandon-meeks/bunny_cdn/releases
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -136,14 +143,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Gem to work with BunnyCDN