cloud_party 0.1.1.pre.alpha.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 601dd1b5d58468c8aad061cee2f8d18a5b84e6d323c774e1ef6a8b74d8be4b5e
-  data.tar.gz: 8df613162612d6265b1bc4a6cbdad2fffcfc4cf8c8f5bca43af66f575374ab02
+  metadata.gz: c9d6d0080a0cd0c540c77091058416c7356ec427394dbdbad571fecae55d2b96
+  data.tar.gz: e2ff2b1c423f6d11bcdbb2cf573c26423b9d64da0cba9dafad3a42c8b2b3154a
 SHA512:
-  metadata.gz: 2cdae24dee8725545e482666bae4b6c7c38ae58afde1810ba7f8d7d954d3edfe3820ccd10dcd12f769c37d757f2a03b60489a8c8f71ac7a56ef67cd294a2cac1
-  data.tar.gz: fbf2b47382b7906807cecea53d1318692e28325cbf487295f198bf851ee81b9c85cd8134e85454829b6d1cdbde3a5a9f09417d92f1b11caad37cf2bef0162540
+  metadata.gz: 8977fd0128fb51169959e3ec22dadcc87bfa48ae6cd22e57b3a93d57d1d24e0f804cca2ed6e9834d116692eca0c49a297966d1c375cae9137f8cc8f3445728e9
+  data.tar.gz: dac649d63809a0fff7269c10763428ba297c45f2277b1268b7b01a9ec199e343ea31f7c94343672e084e92b862748e1a2a6bf29ea4fe38082bf3125949dd2d4d

data/.gitignore

@@ -13,3 +13,4 @@
 /.vscode/
 
 /Deskfile
+/.scannerwork/

data/.rubocop.yml

@@ -1,6 +1,6 @@
 inherit_from: .rubocop_config.yml
 AllCops:
-  TargetRubyVersion: 2.5.1
+  TargetRubyVersion: 2.3
 
 Metrics/AbcSize:
   Max: 23

data/.rubocop_config.yml

@@ -1,4 +1,5 @@
 # Available cops (428) + config for /home/ken/everygit/cloudflare_cli: 
+# Available cops (428) + config for /home/ken/everygit/cloudflare_cli:
 # Department 'Bundler' (4):
 Bundler/DuplicatedGem:
   Description: Checks for duplicate gem entries in Gemfile.
@@ -866,7 +867,7 @@ Lint/FormatParameterMismatch:
 Lint/HandleExceptions:
   Description: Don't suppress exception.
   StyleGuide: "#dont-hide-exceptions"
-  Enabled: true
+  Enabled: false
 
 Lint/ImplicitStringConcatenation:
   Description: Checks for adjacent string literals on the same line, which could better

data/.travis.yml

@@ -1,10 +1,15 @@
 language: ruby
-bundler_args: --jobs=6 --retry=3 --standalone
+bundler_args: "--jobs=6 --retry=3 --standalone"
 script:
-  - echo "Running tests against $(ruby -v) ..."
-  - bundle exec rake -t
+- echo "Running tests against $(ruby -v) ..."
+- bundle exec rake -t
 rvm:
-  - 2.3
-  - 2.4
-  - 2.5
+- 2.3
+- 2.4
+- 2.5
+addons:
+  sonarcloud:
+    organization: iotaspencer-github
+    token:
+      secure: LmYxRG98giIzDDwNdOcgiTK0b5+f+M92672qWhbsXQD9hWQUnPWJpbzRk7+ApjulxIIi28HYqTkS32K4VIPvP8N425idqqoPg98kpjkaG7kqKmj6zXARZSOhW7Qs7c3E0kmGEe10YQi88u75x9caR/aKoL/RmJq2wPCjOqJfVaQczEJb18ULFjLOpdO5AulHNbN3VByjf+miuIM7mztlyPwhH/tXiMxKR5TgTe5L0s2XwCblvxjYD+wQTz538m2CPTqgktlv2FqFxEsjTuZORzALlvBlaFTS/gxYnQhsMUEIE5SfxQ/xuQo1Zg07j8JjTLcTNr9tOBi5Q2mk9sgiLSbJowT/zkQGN6rWizu5NUhJJiVK1IN/B2vnuLCB9XvyeYYrfksxYS36vb2mFLOEt1b/BTjcjVuagc5/3krGR4K16xlyZYoOaAKfYGjmeYKAoNorSWBryZJqZtZA50SroK+2lwEfEokcogz+hbitWWSgUGbIBUowvZP7Sr/J8lWH3887rfANaVziXjmS3G3Dimv12AIdsx5sw3w8Lo7XgZt/P5W+dV6hKpwZvE2NoU8Y7JQyjdHBs6DTrOiIpIk4kgsgeXzgT1ti9VNMZrdlzEbgJKi1CrgvHa7tL9/EjxVBQDJBOBeq5VcoFJRVi/u63FJRlk7QXbrqOXvyDwU4O4Y=
 

data/README.md

@@ -1,28 +1,34 @@
+# CloudParty
+HTTParty based library for Cloudflare
+
+### SonarCloud
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=iotaspencer_gem_cloud_party&metric=alert_status)](https://sonarcloud.io/dashboard?id=cloud_party)
+[![Code Smell](https://sonarcloud.io/api/project_badges/measure?project=iotaspencer_gem_cloud_party&metric=code_smells)](https://sonarcloud.io/dashboard?id=cloud_party)
+
+### Badges
 [![Gem Version](https://badge.fury.io/rb/cloud_party.svg)](https://badge.fury.io/rb/cloud_party)
 [![Code Climate](https://codeclimate.com/github/IotaSpencer/cloud_party/badges/gpa.svg)](https://codeclimate.com/github/IotaSpencer/cloud_party)
 [![Test Coverage](https://codeclimate.com/github/IotaSpencer/cloud_party/badges/coverage.svg)](https://codeclimate.com/github/IotaSpencer/cloud_party/coverage)
 [![Build Status](https://travis-ci.org/IotaSpencer/cloud_party.svg?branch=master)](https://travis-ci.org/IotaSpencer/cloud_party)
-# CloudParty
 
-Super thin Ruby wrapper for Cloudflare's V4 API.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
+```
 gem 'cloud_party'
 ```
 
 And then execute:
 
-```shell
+```
 $ bundle
 ```
 
 Or install it yourself as:
 
-```shell
+```
 $ gem install cloud_party
 ```
 
@@ -98,7 +104,7 @@ p zone.result
 #### Add(POST) an A Record to the zone
 
 ```ruby
-dns_record = connection.post('zones/{#zone.result[:id]}/dns_records', {
+dns_record = connection.post('zones/#!{#zone.result[:id]}/dns_records', {
                              type: 'A',
                              name: 'supercooldomain.com',
                              content: '127.0.0.1'
@@ -111,7 +117,7 @@ p dns_record.result
 #### DELETE a zone
 
 ```ruby
-deleted_zone = connection.delete('zones/#{zone.result[:id]}')
+deleted_zone = connection.delete('zones/#!{zone.result[:id]}')
 
 # Check out the response
 p deleted_zone
@@ -123,7 +129,7 @@ p deleted_zone
 begin
   connection.get('user')
 rescue => e
-  # Inspect e.reponse for more details
+  # Inspect e.response for more details
   p e.response
 end
 ```
@@ -138,7 +144,10 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/trev/rubyflare. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
+## Legal
 
+cloud_party, its developers, and other collaborators are not affiliated with nor endorsed by Cloudflare unless explicitly
+noted
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -2,4 +2,4 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-task default: :test
+task default: :spec

data/cloud_party.gemspec

@@ -4,33 +4,35 @@ lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cloud_party/version'
 
-Gem::Specification.new do |spec|
-  spec.name          = 'cloud_party'
-  spec.version       = CloudParty::VERSION
-  spec.authors       = ['Ken Spencer', 'Trevor Wistaff']
-  spec.email         = ['me+gems@iotaspencer.me', 'trev@a07.com.au']
+spec = Gem::Specification.new do |s|
+  s.name          = 'cloud_party'
+  s.version       = CloudParty::VERSION
+  s.authors       = ['Ken Spencer']
+  s.email         = ['me+gems@iotaspencer.me']
 
-  spec.summary       = "Thin Ruby wrapper around Cloudflare's V4 API. Based on https://github.com/trev/rubyflare"
-  spec.description   = "Thin Ruby wrapper around Cloudflare's V4 API for good measure!"
-  spec.homepage      = 'https://github.com/IotaSpencer/cloud_party'
-  spec.license       = 'MIT'
+  s.summary       = "Thin Ruby wrapper around Cloudflare's V4 API. Based on https://github.com/trev/rubyflare"
+  s.description   = "Thin Ruby wrapper around Cloudflare's V4 API for good measure!"
+  s.homepage      = 'https://github.com/IotaSpencer/cloud_party'
+  s.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = 'bin'
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.require_paths = %w[lib]
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir        = 'bin'
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.require_paths = %w[lib]
 
-  #  spec.required_ruby_version = '>= 2.3'
-  spec.add_development_dependency 'bundler', '~> 1.17.2'
-  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.6.0'
-  spec.add_development_dependency 'debase'
-  spec.add_development_dependency 'pry', '~> 0.11.3'
-  spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.1'
-  spec.add_development_dependency 'rspec', '~> 3.5'
-  spec.add_development_dependency 'ruby-debug-ide', '~> 0.7.0.beta7'
-  spec.add_development_dependency 'webmock', '~> 2.1'
+  s.required_ruby_version = '>= 2.3'
 
-  spec.add_runtime_dependency 'app_configuration'
-  spec.add_runtime_dependency 'httparty', '~> 0.16.2'
-  spec.add_runtime_dependency 'rubyflare'
+  s.add_development_dependency 'bundler', '~> 1.17.2'
+  s.add_development_dependency 'codeclimate-test-reporter', '~> 0.6.0'
+  s.add_development_dependency 'debase'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'minitest-reporters', '>= 0.5.0'
+  s.add_development_dependency 'pry', '~> 0.11.3'
+  s.add_development_dependency 'rake', '~> 12.3', '>= 12.3.1'
+  s.add_development_dependency 'ruby-debug-ide', '~> 0.7.0.beta7'
+  s.add_development_dependency 'webmock', '~> 2.1'
+
+  s.add_runtime_dependency 'app_configuration'
+  s.add_runtime_dependency 'httparty', '~> 0.16.2'
 end
+# spec

data/lib/cloud_party/context.rb

@@ -3,13 +3,11 @@
 require 'httparty'
 require 'cloud_party/config'
 module CloudParty
-  class Context
-    attr_reader :cfg
-    define_singleton_method(:cfg) do
-      CloudParty::Config.new
-    end
-    def self.inherited(subclass)
-      # I don't know yet
+  module Context
+    def self.included(base)
+      base.define_singleton_method(:cfg) do
+        CloudParty::Config.new
+      end
     end
   end
 end

data/lib/cloud_party/exception.rb

@@ -1,61 +1,35 @@
 # frozen_string_literal: true
 
 module CloudParty
-  class ConnectionError < StandardError
-    attr_reader :response
-
-    def initialize(message, response)
-      super(message)
-      @response = response
-    end
-  end
-
-  class APIError < StandardError
-    attr_reader(:response)
-    def initialize(message, response)
-      super(message)
-      @response = response
-    end
-  end
-  class RequestError < StandardError
-    def initialize(obj:, method:, code:, response:, endpoint:)
-      @obj      = obj
-      @method   = method
-      @endpoint = endpoint
-      @code     = code
-      @response = response
-    end
-
-    def to_s
-      [error_string.squish, extra_string].join("\n")
+  module Errors
+    class APIError < StandardError
+      attr_reader(:response)
+      def initialize(message, response)
+        super(message)
+        @response = response
+      end
     end
-
-    def self.extra_string; end
-
-    def self.error_string; end
-  end
-  class UnknownError < RequestError
-    def initialize(obj:, method:, response:, endpoint: nil, code:)
-      super
-    end
-
-    def self.error_string
-      <<~HEREDOC
-        An error with the request has occurred, please make
-        sure the method verb, endpoint, and credentials are
-        correct for this request.
-      HEREDOC
-    end
-
-    def self.extra_string
-      <<~HEREDOC
-        Credentials Context: #{@obj&.class&.cfg}
-
-        Method Verb: #{@method}
-        Endpoint: #{@endpoint}
-        HTTP Status Code: #{@code}
-        Response Body: #{@response.body}
-      HEREDOC
+    class RequestError < StandardError
+      def initialize(obj:, method:, code:, response:, endpoint:)
+        @obj      = obj
+        @method   = method
+        @endpoint = endpoint
+        @code     = code
+        @response = response
+      end
+
+      def to_s
+        [error_string.squish, extra_string].join("\n")
+      end
+
+      def self.extra_string
+        # This method should be overridden
+      end
+
+      # override error_string to provide your own error_string
+      def self.error_string
+        # This method should be overridden
+      end
     end
   end
 end

data/lib/cloud_party/exceptions/request_errors/bad_request_error.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'cloud_party/exception'
+module CloudParty
+  module Errors
+    # Request was invalid
+    class BadRequestError < RequestError
+      def initialize(obj:, method:, response:, endpoint: nil, code: 400)
+        super
+      end
+
+      def self.error_string
+        <<~HEREDOC
+          There was a '400 -- Bad Request' error.
+        HEREDOC
+      end
+
+      def self.extra_string
+        <<~HEREDOC
+          VERB: #{@method}
+
+        HEREDOC
+      end
+    end
+  end
+end

data/lib/cloud_party/exceptions/request_errors/forbidden_error.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'cloud_party/exception'
+module CloudParty
+  module Errors
+    # Page/Endpoint doesn't exist
+    class ForbiddenError < RequestError
+      def initialize(obj:, method:, response:, endpoint: nil, code: 403)
+        super
+      end
+
+      def self.error_string
+        <<~HEREDOC
+          There was a '401 -- Unauthorized' error.
+        HEREDOC
+      end
+
+      def self.extra_string
+        <<~HEREDOC
+          VERB: #{@method}
+
+        HEREDOC
+      end
+    end
+  end
+end

data/lib/cloud_party/exceptions/request_errors/method_not_allowed_error.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'cloud_party/exception'
+module CloudParty
+  module Errors
+    # Page/Endpoint doesn't exist
+    class MethodNotAllowedError < RequestError
+      def initialize(obj:, method:, response:, endpoint: nil, code: 405)
+        super
+      end
+
+      def self.error_string
+        <<~HEREDOC
+          There was a '429 -- Too many requests' error.
+          You've hit the rate limit of Cloudflare
+        HEREDOC
+      end
+
+      def self.extra_string
+        <<~HEREDOC
+          VERB: #{@method}
+
+        HEREDOC
+      end
+    end
+  end
+end

data/lib/cloud_party/exceptions/request_errors/not_found_error.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'cloud_party/exception'
+module CloudParty
+  module Errors
+    # Page/Endpoint doesn't exist
+    class NotFoundError < RequestError
+      def initialize(obj:, method:, response:, endpoint: nil, code: 404)
+        super
+      end
+
+      def self.error_string
+        <<~HEREDOC
+          There was a '404 -- Not Found' error.
+        HEREDOC
+      end
+
+      def self.extra_string
+        <<~HEREDOC
+          VERB: #{@method}
+
+        HEREDOC
+      end
+    end
+  end
+end

data/lib/cloud_party/exceptions/request_errors/too_many_requests_error.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'cloud_party/exception'
+module CloudParty
+  module Errors
+    # Page/Endpoint doesn't exist
+    class TooManyRequestsError < RequestError
+      def initialize(obj:, method:, response:, endpoint: nil, code: 429)
+        super
+      end
+
+      def self.error_string
+        <<~HEREDOC
+          There was a '429 -- Too many requests' error.
+          You've hit the rate limit of Cloudflare
+        HEREDOC
+      end
+
+      def self.extra_string
+        <<~HEREDOC
+          VERB: #{@method}
+
+        HEREDOC
+      end
+    end
+  end
+end

data/lib/cloud_party/exceptions/request_errors/unauthorized_error.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'cloud_party/exception'
+module CloudParty
+  module Errors
+    # Page/Endpoint doesn't exist
+    class UnauthorizedError < RequestError
+      def initialize(obj:, method:, response:, endpoint: nil, code: 401)
+        super
+      end
+
+      def self.error_string
+        <<~HEREDOC
+          There was a '401 -- Unauthorized' error.
+        HEREDOC
+      end
+
+      def self.extra_string
+        <<~HEREDOC
+          VERB: #{@method}
+
+        HEREDOC
+      end
+    end
+  end
+end

data/lib/cloud_party/exceptions/request_errors/unsupported_media_type_error.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'cloud_party/exception'
+module CloudParty
+  module Errors
+    # Page/Endpoint doesn't exist
+    class UnsupportedMediaTypeError < RequestError
+      def initialize(obj:, method:, response:, endpoint: nil, code: 415)
+        super
+      end
+
+      def self.error_string
+        <<~HEREDOC
+          There was a '429 -- Too many requests' error.
+          You've hit the rate limit of Cloudflare
+        HEREDOC
+      end
+
+      def self.extra_string
+        <<~HEREDOC
+          VERB: #{@method}
+
+        HEREDOC
+      end
+    end
+  end
+end

data/lib/cloud_party/exceptions/request_errors.rb

@@ -0,0 +1,25 @@
+module CloudParty
+  module Errors
+    ##
+    # 400
+    autoload :BadRequestError, 'cloud_party/exceptions/request_errors/bad_request_error'
+    ##
+    # 401
+    autoload :UnauthorizedError, 'cloud_party/exceptions/request_errors/unauthorized_error'
+    ##
+    # 403
+    autoload :ForbiddenError, 'cloud_party/exceptions/request_errors/forbidden_error'
+    ##
+    # 404
+    autoload :NotFoundError, 'cloud_party/exceptions/request_errors/not_found_error'
+    ##
+    # 405
+    autoload :MethodNotAllowedError, 'cloud_party/exceptions/request_errors/method_not_allowed_error'
+    ##
+    # 415
+    autoload :UnsupportedMediaTypeError, 'cloud_party/exceptions/request_errors/unsupported_media_type_error'
+    ##
+    # 429
+    autoload :TooManyRequestsError, 'cloud_party/exceptions/request_errors/too_many_requests_error'
+  end
+end

data/lib/cloud_party/exceptions/un_recognized_endpoint_error.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module CloudParty
+  module Errors
+    ##
+    # UnRecognizedEndpointError
+    #
+    # When an endpoint is not recognized by the gem logic
+    class UnRecognizedEndpointError < StandardError
+      attr_reader :endpoint, :klass
+
+      def initialize(endpoint, klass)
+        super("'#{endpoint}' is not a recognized endpoint for class #{klass}")
+        @endpoint = endpoint
+        @klass = klass
+      end
+    end
+  end
+
+end

data/lib/cloud_party/exceptions/un_recognized_result_type_error.rb

@@ -0,0 +1,14 @@
+
+##
+# Raised when the result's `body` is not a recognized class
+module CloudParty
+  module Errors
+    class UnRecognizedResultTypeError < StandardError
+      attr_reader :result_class
+
+      def initialize(result_object)
+        @result_class = result_object.class
+      end
+    end
+  end
+end

data/lib/cloud_party/exceptions.rb

@@ -1,6 +1,47 @@
 # frozen_string_literal: true
 
 require 'cloud_party/exception'
+require 'cloud_party/exceptions/request_errors'
 module CloudParty
-  autoload :BadRequestError, 'cloud_party/exceptions/bad_request_400'
+  module Errors
+
+    ##
+    # ### ConnectionError
+    class ConnectionError < StandardError
+      attr_reader :response
+
+      def initialize(message, response)
+        super(message)
+        @response = response
+      end
+    end
+
+    class UnknownError < RequestError
+      def initialize(obj:, method:, response:, endpoint: nil, code:)
+        super
+      end
+
+      def self.error_string
+        <<~HEREDOC
+          An error with the request has occurred, please make
+          sure the method verb, endpoint, and credentials are
+          correct for this request.
+        HEREDOC
+      end
+
+      def self.extra_string
+        <<~HEREDOC
+          Credentials Context: #{@obj&.class&.cfg}
+
+          Method Verb: #{@method}
+          Endpoint: #{@endpoint}
+          HTTP Status Code: #{@code}
+          Response Body: #{@response.body}
+        HEREDOC
+      end
+    end
+    autoload :UnRecognizedResultTypeError, 'cloud_party/exceptions/un_recognized_result_type_error'
+    autoload :UnRecognizedEndpointError, 'cloud_party/exceptions/un_recognized_endpoint_error'
+
+  end
 end

data/lib/cloud_party/nodes/accounts.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'cloud_party/context'
+require 'cloud_party/responses'
+module CloudParty
+  module Nodes
+    class Accounts
+      include CloudParty::Context
+      include HTTParty
+      base_uri 'api.cloudflare.com:443/client/v4'
+      headers 'X-Auth-Email' => cfg.email,
+              'X-Auth-Key' => cfg.api_key,
+              'Content-Type' => 'application/json',
+              'User-Agent' => "CloudParty/#{CloudParty::VERSION}"
+
+      def initialize(options = nil)
+        super()
+        @options = options
+      end
+
+      def list
+        CloudParty::Responses::Accounts.new(:get, '/accounts', self.class.get('/accounts'), @options)
+      end
+    end
+  end
+end