bunny_cdn 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf754f9171d7ac48ac64209f2822859d5d2e29818930a6697c2b8f883f66440e
-  data.tar.gz: 19b3e2827b72883c333fd5b32d57227adf78c2e5f58bbfe9ac3fe1fd6eb10621
+  metadata.gz: bea0b6898e3d9cea923f34e55c7c8d47d96ea1396a44bfd6926183a22cea11e8
+  data.tar.gz: 0cedfeca304e7c73baaaee1859bfc98581f822c55396b7cc11fb77d376885bff
 SHA512:
-  metadata.gz: 11c8f7f14557a6430502d4771f593ecea2872b348d2ea300609ad5b250bf838659d812aa7198725ab98be932984908198d432b60e324ab8a4f3a664e40013584
-  data.tar.gz: 255661ca9dc602fa9c319742446d0894b970cd654b30e97cb23bc85e95218058c3d9eff5599de1275bc681c3e8ac3e40e345478aa6fc093f287d32d203ca84fc
+  metadata.gz: db13a1be2ddfd7a85c89c7962fe5f25e88f64509b4aac2da5212770fdbd015a6e2b8651245a3cdc31a31474c59dd7e326e650fe47ea0f473ea206922a1892390
+  data.tar.gz: 1c66fc0ca92135505f098c63061d6461157a2a894803ff7adaab64f2d9a39ceeb1b46ac15524c07fe0c6d082bb71689a4e14cb075414b767006ea32f25e3b3f8

data/README.md

@@ -34,7 +34,7 @@ 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, or 'sg' for Asia
+    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
 ```

data/bunny_cdn.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'json', '~> 2.3'
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", ">= 12.3.3"
+  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'
 

data/lib/bunny_cdn/configuration.rb

@@ -2,9 +2,10 @@ module BunnyCdn
     class Configuration
         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 or sg (Asia)
+            @region = nil # Options are: eu, ny, la or sg (Asia)
             @accessKey = nil
             @apiKey = nil
         end
@@ -14,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

@@ -3,12 +3,14 @@ module BunnyCdn
 
     RestClient.log = STDOUT # enables RestClient logging
 
-    BASE_URL = 'https://bunnycdn.com/api/pullzone'
+    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,
@@ -17,6 +19,7 @@ module BunnyCdn
       }
     end
 
+    # Gets all Pull Zones from BunnyCDN
     def self.getAllPullzones
       begin
         response = RestClient.get(BASE_URL, headers)
@@ -26,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,
@@ -40,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)
@@ -49,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)
@@ -58,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

@@ -3,9 +3,11 @@ module BunnyCdn
     
     RestClient.log = STDOUT # enables RestClient logging
 
+    # 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
@@ -13,21 +15,28 @@ module BunnyCdn
         '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= '')
       begin
         response = RestClient.get("#{set_region_url}/#{storageZone}/#{path}", headers)
@@ -37,6 +46,10 @@ module BunnyCdn
       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)
       begin
         response = RestClient.get("#{set_region_url}/#{storageZone}/#{path}/#{file}", headers)
@@ -46,6 +59,10 @@ module BunnyCdn
       return response.body
     end
 
+    # Uploads a file 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 = {
@@ -60,6 +77,10 @@ module BunnyCdn
       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)
       begin
         response = RestClient.delete("#{set_region_url}/#{storageZone}/#{path}/#{file}", headers)

data/lib/bunny_cdn/version.rb

@@ -1,3 +1,3 @@
 module BunnyCdn
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bunny_cdn
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Brandon Meeks
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2020-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -56,6 +56,9 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
     - - ">="
       - !ruby/object:Gem::Version
         version: 12.3.3
@@ -63,6 +66,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
     - - ">="
       - !ruby/object:Gem::Version
         version: 12.3.3