record_store 5.7.0 → 5.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dea515dfa1642780adedb1353bcae13ea6882092926a3c030623c67dbdff0bbe
-  data.tar.gz: 888a2d16c617080fd4a25fc36c21d39f2920cc5c287d1e046e8e98831f70e05a
+  metadata.gz: 76a9b267be27d4f9f0f013f7bbfd4ea2b55f5e364bf720abd614244ae0943c04
+  data.tar.gz: d638f51c612e9e45aca478400ddd7f3b42d20bc4de0cf8575bd26efd6d8d9002
 SHA512:
-  metadata.gz: 18fe6d29ec4be5a40659aadbab31c2111bf84a376a670862270b469a8e244689883980a6e4224156ebab11984d9a8f034b0d1dd0a7bcbbaac590044a6047e602
-  data.tar.gz: d671eae01d176ed3da8ef298c32fdaafe42880798e47c0a41e93b018c1b26c01543b239bce26f57f042bfd07ea761d2c46ba098042efad605f1694a842fadce6
+  metadata.gz: aa98bccefee0aedecde5a2ea5582205fe8abdd4324220e76a3e728dfd43fef909be0e4561d828f6a41e91e908ea5d9f481fc8e1714d0adb80c3ffc38ef67f1ec
+  data.tar.gz: b2b8bde921e73d537a48edc9fc8f9ae731f2af91555b713ad565e5f4deb6e9b05d7d55cee3f9d8e9dffb1dc8ed70cfa5e000570186fffc9477fa4efb41985ec4

data/.rubocop-https---shopify-github-io-ruby-style-guide-rubocop-yml

@@ -819,13 +819,13 @@ Layout/TrailingWhitespace:
 Style/UnlessElse:
   Enabled: true
 
-Style/UnneededCapitalW:
+Style/RedundantCapitalW:
   Enabled: true
 
-Style/UnneededInterpolation:
+Style/RedundantInterpolation:
   Enabled: true
 
-Style/UnneededPercentQ:
+Style/RedundantPercentQ:
   Enabled: true
 
 Style/VariableInterpolation:
@@ -956,13 +956,13 @@ Lint/UnderscorePrefixedVariableName:
 Lint/UnifiedInteger:
   Enabled: true
 
-Lint/UnneededCopDisableDirective:
+Lint/RedundantCopDisableDirective:
   Enabled: true
 
-Lint/UnneededCopEnableDirective:
+Lint/RedundantCopEnableDirective:
   Enabled: true
 
-Lint/UnneededSplatExpansion:
+Lint/RedundantSplatExpansion:
   Enabled: true
 
 Lint/UnreachableCode:

data/CHANGELOG.md

@@ -1,4 +1,7 @@
 # CHANGELOG
+## 5.7.1
+- add API rate limit for NS1 provider [FEATURE]
+
 ## 5.7.0
 - add OCI library as runtime dependency [FEATURE]
 

data/README.md

@@ -53,6 +53,42 @@ In addition, the `AliasService` permission is required to be able to read or wri
 
 For a breakdown of what each permission allows read through [DynECT's permissions guide](https://help.dyn.com/user-and-group-permissions/).
 
+### Google Cloud DNS
+
+In order to use Google Cloud DNS, you'll need to add the `Service Account Credentials` to `secrets.json`. The `Service Account Credentials` is a JSON format file that you need to generate on Google Cloud Platform. You can find more details about the authentication from [here](https://googleapis.dev/ruby/google-cloud-dns/latest/file.AUTHENTICATION.html).
+
+Here's an example of the JSON format file. You can simply copy all information and paste to `secrets.json` under the key, `google_cloud_dns`.
+```json
+{
+"type": "service_account",
+"project_id": "[PROJECT-ID]",
+"private_key_id": "[KEY-ID]",
+"private_key": "-----BEGIN PRIVATE KEY-----\n[PRIVATE-KEY]\n-----END PRIVATE KEY-----\n",
+"client_email": "[SERVICE-ACCOUNT-EMAIL]",
+"client_id": "[CLIENT-ID]",
+"auth_uri": "https://accounts.google.com/o/oauth2/auth",
+"token_uri": "https://accounts.google.com/o/oauth2/token",
+"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+"client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/[SERVICE-ACCOUNT-EMAIL]"
+}
+```
+
+### NS1
+
+To use NS1, you'll need the API key generated from `Account Settings` on NS1 website. Add the generated API to the value of the `api_key` key of the `ns1` object in `secrets.json`.
+
+### Oracle Cloud Infrastructure
+
+In order to use OCI, you'll need to add the `compartment_id`, `user`, `fingerprint`, `key_content`, `tenancy`, and `region` keys to `secrets.json`.
+
+To find the `compartment_id`, the value you need is available in the `Compartment Details`, that you can find by following the `Identity` menu on the website, and selecting the `Compartments` menu. The value you want starts with `ocid1.compartment.oci..` or `ocid1.tenancy.oci..`.
+
+The `user` will be found in the `User Details`, that you can find by following the `Users` on the website, and selecting the `Identity` menu on the website, and the value starts with `ocid1.user.oc1..`.
+
+Regarding the `fingerprint` and `key_content`, you'll need to generate an API Signing Key (key pair) by following [these steps](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm).
+
+The `tenancy` and `region` are in the `Profile` menu. The `tenancy` starts with `ocid1.tenancy.oc1..`.
+
 ----
 
 # Architecture
@@ -131,14 +167,14 @@ class Provider
   #
   # Arguments:
   # record - a kind of `Record`
-  def add(record)
+  def add(zone, record)
   end
 
   # Deletes an existing record from the zone. It is expected this call modifies external state.
   #
   # Arguments:
   # record - a kind of `Record`
-  def remove(record)
+  def remove(zone, record)
   end
 
   # Updates an existing record in the zone. It is expected this call modifies external state.
@@ -146,7 +182,7 @@ class Provider
   # Arguments:
   # id - provider specific ID of record to update
   # record - a kind of `Record` which the record with `id` should be updated to
-  def update(id, record)
+  def update(zone, id, record)
   end
 end
 ```

data/dev.yml

@@ -2,7 +2,7 @@
 name: recordstore
 
 up:
-  - ruby: 2.4.3
+  - ruby: 2.5.0
   - bundler
 
 commands:

data/lib/record_store/provider/ns1.rb

@@ -1,4 +1,5 @@
 require_relative 'ns1/client'
+require_relative 'ns1/patch_api_header'
 
 module RecordStore
   class Provider::NS1 < Provider

data/lib/record_store/provider/ns1/patch_api_header.rb

@@ -0,0 +1,21 @@
+require 'net/http'
+
+# Patch the method which retrieves headers for API rate limit dynamically
+module NS1::Transport
+  class NetHttp
+    def process_response(response)
+      sleep(response.to_hash["x-ratelimit-period"].first.to_i /
+        [1, response.to_hash["x-ratelimit-remaining"].first.to_i].max.to_f)
+
+      body = JSON.parse(response.body)
+      case response
+      when Net::HTTPOK
+        NS1::Response::Success.new(body, response.code.to_i)
+      else
+        NS1::Response::Error.new(body, response.code.to_i)
+      end
+    rescue JSON::ParserError
+      raise NS1::Transport::ResponseParseError
+    end
+  end
+end

data/lib/record_store/version.rb

@@ -1,3 +1,3 @@
 module RecordStore
-  VERSION = '5.7.0'.freeze
+  VERSION = '5.7.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: record_store
 version: !ruby/object:Gem::Version
-  version: 5.7.0
+  version: 5.7.1
 platform: ruby
 authors:
 - Willem van Bergen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-22 00:00:00.000000000 Z
+date: 2019-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -345,6 +345,7 @@ files:
 - lib/record_store/provider/google_cloud_dns.rb
 - lib/record_store/provider/ns1.rb
 - lib/record_store/provider/ns1/client.rb
+- lib/record_store/provider/ns1/patch_api_header.rb
 - lib/record_store/provider/oracle_cloud_dns.rb
 - lib/record_store/record.rb
 - lib/record_store/record/a.rb