opensrs 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 127ecdac1c36fe084303d59efca748da537ce37a
-  data.tar.gz: f4018a9dd533a217dcc80f6692e642f28d38cd4d
+SHA256:
+  metadata.gz: 71d1e83d17bb3fbcf14fe9da34120322c4411bfeb37b9f6023806467025e5d5f
+  data.tar.gz: 941f1cc4275cf0f64635d6ed5e326a7ebdb9bc6ee98230c495de7e809637d661
 SHA512:
-  metadata.gz: 9268aa3a9cca1924ca1b8e40257caaeb630cb3133dd78562ef734ca1e291e0467d4b927ecfac4f0c3698667b7d2772854796ff89f8a8b0c868a80c93d3a4d278
-  data.tar.gz: e9b96abc301ff7a2f1101374847c44c3b1c5821351e5f7e7bd2fec9bfaaac2508fcb9177c6125b52ea8ca79261fca5ffc49341c483af38273346ad90b7fb872f
+  metadata.gz: df149b8fcd50164c419c51aa789d4dab1e8409952ec0b4b1f2fcd202948111512931d82a5169635b8690feec9f01d82fba0548b5952691dcf2d3323081b25210
+  data.tar.gz: 54e8f4bcbb4538d6215d94dd3bcd797f59dffa7e120a181b2af62d4f38c1cf8fb737d8298e516feda9f7bfc7b100b894714ea33cab4f8fc00458ab95b4b5c330

data/.github/workflows/rubocop-analysis.yml

@@ -0,0 +1,43 @@
+# pulled from repo
+name: "Rubocop"
+
+on:
+  push:
+    branches: [ master, rubocop ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master, rubocop ]
+  schedule:
+    - cron: '37 10 * * 2'
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # If running on a self-hosted runner, check it meets the requirements
+    # listed at https://github.com/ruby/setup-ruby#using-self-hosted-runners
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+
+    - name: Install dependencies
+      run: bundle install
+
+    - name: Rubocop run
+      run: |
+        bash -c "
+          bundle exec rubocop --require code_scanning --format CodeScanning::SarifFormatter -o rubocop.sarif
+          [[ $? -ne 2 ]]
+        "
+
+    - name: Upload Sarif output
+      uses: github/codeql-action/upload-sarif@v1
+      with:
+        sarif_file: rubocop.sarif

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.vscode
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.gem
+mkmf.log
+*.sarif

data/.rspec

@@ -0,0 +1,3 @@
+--format doc
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,131 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.5
+  SuggestExtensions: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+RSpec/FilePath:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/StubbedMock:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/ClassVars:
+  Enabled: false
+
+Gemspec/DateAssignment: # (new in 1.10)
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation: # (new in 1.18)
+  Enabled: true
+Layout/SpaceBeforeBrackets: # (new in 1.7)
+  Enabled: true
+Lint/AmbiguousAssignment: # (new in 1.7)
+  Enabled: true
+Lint/AmbiguousRange: # (new in 1.19)
+  Enabled: true
+Lint/DeprecatedConstants: # (new in 1.8)
+  Enabled: true
+Lint/DuplicateBranch: # (new in 1.3)
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
+  Enabled: true
+Lint/EmptyBlock: # (new in 1.1)
+  Enabled: true
+Lint/EmptyClass: # (new in 1.3)
+  Enabled: true
+Lint/EmptyInPattern: # (new in 1.16)
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # (new in 1.8)
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
+  Enabled: true
+Lint/NumberedParameterAssignment: # (new in 1.9)
+  Enabled: true
+Lint/OrAssignmentToConstant: # (new in 1.9)
+  Enabled: true
+Lint/RedundantDirGlobSort: # (new in 1.8)
+  Enabled: true
+Lint/SymbolConversion: # (new in 1.9)
+  Enabled: true
+Lint/ToEnumArguments: # (new in 1.1)
+  Enabled: true
+Lint/TripleQuotes: # (new in 1.9)
+  Enabled: true
+Lint/UnexpectedBlockArity: # (new in 1.5)
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
+  Enabled: true
+Naming/InclusiveLanguage: # (new in 1.18)
+  Enabled: true
+Style/ArgumentsForwarding: # (new in 1.1)
+  Enabled: true
+Style/CollectionCompact: # (new in 1.2)
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # (new in 1.1)
+  Enabled: true
+Style/EndlessMethod: # (new in 1.8)
+  Enabled: true
+Style/HashConversion: # (new in 1.10)
+  Enabled: true
+Style/HashExcept: # (new in 1.7)
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # (new in 1.9)
+  Enabled: true
+Style/InPatternThen: # (new in 1.16)
+  Enabled: true
+Style/MultilineInPatternThen: # (new in 1.16)
+  Enabled: true
+Style/NegatedIfElseCondition: # (new in 1.2)
+  Enabled: true
+Style/NilLambda: # (new in 1.3)
+  Enabled: true
+Style/QuotedSymbols: # (new in 1.16)
+  Enabled: true
+Style/RedundantArgument: # (new in 1.4)
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # (new in 1.19)
+  Enabled: true
+Style/StringChars: # (new in 1.12)
+  Enabled: true
+Style/SwapValues: # (new in 1.1)
+  Enabled: true
+RSpec/IdenticalEqualityAssertion: # (new in 2.4)
+  Enabled: true
+RSpec/Rails/AvoidSetupHook: # (new in 2.4)
+  Enabled: true

data/Gemfile

@@ -1,12 +1,3 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
-gem "libxml-ruby", "~> 2.6.0"
-
-group :development do
-  gem "nokogiri", "~> 1.4.6"
-  gem "jeweler"
-  gem "git"
-  gem "rake"
-  gem "shoulda"
-  gem "rspec", "~> 2.0"
-end
+gemspec

data/Gemfile.lock

@@ -1,53 +1,99 @@
+PATH
+  remote: .
+  specs:
+    opensrs (0.3.8)
+
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    activesupport (3.2.13)
-      i18n (= 0.6.1)
-      multi_json (~> 1.0)
-    bourne (1.1.2)
-      mocha (= 0.10.5)
-    diff-lcs (1.2.1)
-    git (1.2.5)
-    i18n (0.6.1)
-    jeweler (1.8.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
-    json (1.7.7)
-    libxml-ruby (2.6.0)
-    metaclass (0.0.1)
-    mocha (0.10.5)
-      metaclass (~> 0.0.1)
-    multi_json (1.7.1)
-    nokogiri (1.4.7)
-    rake (10.0.3)
-    rdoc (4.0.0)
-      json (~> 1.4)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.0)
-    shoulda (3.3.2)
-      shoulda-context (~> 1.0.1)
-      shoulda-matchers (~> 1.4.1)
-    shoulda-context (1.0.2)
-    shoulda-matchers (1.4.2)
+    activesupport (4.2.10)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ast (2.4.2)
+    code-scanning-rubocop (0.5.0)
+      rubocop (~> 1.0)
+    coderay (1.1.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.2.5)
+    i18n (0.9.3)
+      concurrent-ruby (~> 1.0)
+    libxml-ruby (3.2.1)
+    method_source (0.8.2)
+    mini_portile2 (2.5.1)
+    minitest (5.11.3)
+    nokogiri (1.11.4)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    racc (1.5.2)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    rubocop (1.19.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.10.0)
+      parser (>= 3.0.1.1)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.8.0)
       activesupport (>= 3.0.0)
-      bourne (~> 1.1.2)
+    slop (3.6.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+    unicode-display_width (2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  git
-  jeweler
-  libxml-ruby (~> 2.6.0)
-  nokogiri (~> 1.4.6)
+  activesupport (~> 4.2.2)
+  bundler
+  code-scanning-rubocop (~> 0.5)
+  libxml-ruby (~> 3)
+  nokogiri (~> 1.11.4)
+  opensrs!
+  pry
   rake
-  rspec (~> 2.0)
+  rspec
+  rubocop (~> 1)
+  rubocop-rspec
   shoulda
+
+BUNDLED WITH
+   1.17.2

data/{LICENSE → LICENSE.txt}

@@ -1,4 +1,6 @@
-Copyright (c) 2010-2011 Josh Delsman
+Copyright (c) 2014 Joshua Delsman
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,126 @@
+# OpenSRS
+
+[![Coverage Status](https://img.shields.io/coveralls/voxxit/opensrs.svg)](https://coveralls.io/r/voxxit/opensrs)
+
+This unofficial OpenSRS gem provides basic support to connect to and utilize the [OpenSRS API.](http://www.opensrs.com/site/resources/documentation/api) This library has been well-tested in high-performance production
+environments.
+
+### Requirements
+
+  * Ruby **>= 2.5**
+
+### Installation
+
+You can install this gem by doing the following:
+
+    $ gem install opensrs
+
+You can then include it in a Ruby project, like so:
+
+    require 'opensrs'
+
+For Rails 3.x and above, add it to the `Gemfile`:
+
+    gem 'opensrs'
+    gem 'nokogiri'    # if you want to use nokogiri as the XML parser
+    gem 'libxml-ruby' # if you want to use libxml as the XML parser
+
+### Usage
+
+This library provides basic functionality for interacting with the OpenSRS XML API.
+
+- Connection handling
+- Error reporting
+- XML encoding
+- XML decoding
+
+Currently, the library supports LibXML and Nokogiri as XML parsers. By default, it uses LibXML to parse and generate XML. If you'd like to use Nokogiri (1.4.7 and below) for parsing XML, then in one of your app initializers add the following line:
+
+    OpenSRS::Server.xml_processor = :nokogiri
+
+or
+
+    OpenSRS::Server.xml_processor = :libxml
+
+To connect, instantiate a new <tt>OpenSRS::Server</tt> object:
+
+    server = OpenSRS::Server.new(
+      server:   "https://rr-n1-tor.opensrs.net:55443/",
+      username: "testing",
+      password: "53cr3t",
+      key:      "c633be3170c7fb3fb29e2f99b84be2410..."
+    )
+
+**NOTE:** Connecting to OpenSRS requires that you add the IP(s) you're connecting from to their whitelist. Log in to the testing or production servers, and add your IP(s) under Profile Management > Add IPs for Script/API Access. IP changes take about one hour to take effect.
+
+If you would like, you can provide OpenSRS::Server with a logger to write the contents of the requests and responses
+with OpenSRS. The assumption is you are using a Rails-like logger, but as long as your logger has an info method you
+are fine. You can simply assign the logger or pass it in as an initialization option:
+
+    server = OpenSRS::Server.new(
+      server:   "https://rr-n1-tor.opensrs.net:55443/",
+      username: "testing",
+      password: "53cr3t",
+      key:      "c633be3170c7fb3fb29e2f99b84be2410...",
+      logger:   Rails.logger
+    )
+
+or, if you can change it later:
+
+    server.logger = Rails.logger
+
+Once you have a server connection class, you can build from this to create the methods that you need. For instance, let's say we want to grab our account balance. The OpenSRS XML API takes a couple of attributes for all commands. You can include those here:
+
+    def get_balance
+      server.call(
+        action: "GET_BALANCE",
+        object: "BALANCE"
+      )
+    end
+
+Sometimes you might need to include attributes for the command, such as a cookie, or the data attributes themselves. You can do this, too:
+
+    def create_nameserver(nameserver)
+      server.call(
+        action: "CREATE",
+        object: "NAMESERVER",
+        cookie: "366828736:3210384",
+        attributes: {
+          name: nameserver.hostname,
+          ipaddress: "212.112.123.11"
+        }
+      )
+    end
+
+Responses from OpenSRS are returned in an OpenSRS::Response object, which gives you access to a multitude of things.
+
+  Method | Description
+  ---|---
+  `response.response` | This gives you the response in a Hash form, which is highly accessible to most other actions in your application.
+  `response.errors` | If there are errors which come back from OpenSRS, they are returned here. If not, it returns nil.
+  `response.success?` | Returns true if the response was labeled as successful. If not, it returns false.
+  `response.request_xml` | Returns raw request XML.
+  `response.response_xml` | Returns raw response XML.
+
+### Bugs/Feature Requests
+
+If you have any bugs or feature requests for this gem, feel free to [open an issue.](http://github.com/voxxit/opensrs/issues/new)
+
+### How To Contribute
+
+  * Fork the project.
+  * Make your feature addition or bug fix.
+  * Add specs for it.
+  * Commit, but **do not mess with Rakefile or version.**
+  * Send me a pull request. Bonus points for topic branches!
+
+### Contributors (in order of appearance)
+
+* [Joshua Delsman](http://github.com/voxxit)
+* Glenn Roberts
+
+### Copyright
+
+Copyright (c) 2010-2021 Joshua Delsman.
+
+Distributed under the MIT license. See `LICENSE` for details.