cisco_nxapi 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02b798d719eedf373814ac7666a93169f6d3bade
-  data.tar.gz: 8796e7a3e3a94e8e6ea421f3c037091469f0d574
+  metadata.gz: 63d9532b69dca7a3d89222ab55572a22cd3eabac
+  data.tar.gz: e16273c18cbb27992cde626b79d966395edc6f7d
 SHA512:
-  metadata.gz: 81cda2b93af091507ae8a528e62ef20319b49d1e255e762079164fa2a303f916266ce4f043bf40529a7556ba1ba491e1e794e57e27a268228eef70b42496cce7
-  data.tar.gz: 05c7cc8332991d7bcdbfc634349d8b15b23d9bd0ff21014b24cb5af98c69b1299780bd4337965c3b092b406e909324e598643d23aed63abf4390039070108245
+  metadata.gz: efceaaee7cca21224a8a105998b203f7c3f44a08decc02cca3f2b9bac0fafb3e7b2bec923b3e26b84561c53183803060275f72637a623685745310f5726aac41
+  data.tar.gz: 6bbde4135eba7ab19101df8d7c551925f99dfd539d4665ee42e7212de77f46a84c848c0a5185cbaac3281f6e2022406c5de533e775101b8b136d188571738d34

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+Changelog
+=========
+
+1.0.0
+-----
+
+* Change the http read timeout from default 60 seconds to 300 seconds.
+* Recognize and handle NXAPI error code 413 (request too large).
+
 0.9.0
 -----
 

data/CONTRIBUTING.md

@@ -1,19 +1,33 @@
-# Contributing
+# How to contribute
+Cisco Network Elements support a rich set of features to make networks robust, efficient and secure. The GitHub project [cisco-network-puppet-module](https://github.com/cisco/cisco-network-puppet-module) defines a set of Puppet resource types and providers to manage the network element. Similarly, the GitHub project [cisco-network-chef-cookbook](https://github.com/cisco/cisco-network-chef-cookbook) defines a set of Chef resources and providers for network element management. The providers defined in these projects leverage a common set of Ruby API Objects defined in this project. This object set is expected to grow with contributions from Cisco, Cisco-Partners and third-party alike. Contributions to this project are welcome. To ensure code quality, contributors will be requested to follow few guidelines.
 
-## Submitting an Issue
+## Getting Started
 
-Issues are tracked on GitHub (TODO).
+* Create a [GitHub account](https://github.com/signup/free)
+* Create a [cisco.com](http://cisco.com) account if you need access to a Network Simulator to test your code.
 
-## Submitting a Pull Request
+## Making Changes
 
-1. Fork the code (https://github.com/cisco/cisco_nxapi/fork) (TODO)
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Write your code
-4. Write minitest cases to cover your new code
-5. Verify that minitest passes in full (`ruby tests/test_all_cisco.rb --
-   n3k_test.mycompany.com username password`)
-6. Run rubocop (`rake rubocop`) and fix any failures.
-7. Commit your changes (`git commit -am 'Add some feature'`)
-8. Push to the branch (`git push origin my-new-feature`)
-9. Create a new Pull Request
+* Fork the repository
+  * Pull a branch under the "develop" branch for your changes.
+  * Make changes in your branch.
+* Testing
+  * Create a minitest for new APIs or new functionality
+  * Run all the tests to ensure there was no collateral damage to existing code
+* Committing
+  * Check for unnecessary whitespace with `git diff --check` before committing.
+  * Run `rubocop --lint` against all changed files. See [https://rubygems.org/gems/rubocop](https://rubygems.org/gems/rubocop)
+  * Make sure your commit messages clearly describe the problem you are trying to solve and the proposed solution.
+
+## Submitting Changes
+
+* All contributions you submit to this project are voluntary and subject to the terms of the Apache 2.0 license
+* Submit a pull request to the repository
+* A core team consisting of Cisco and Cisco-Partner employees will looks at Pull Request and provide feedback.
+* After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
 

data/SUPPORT.md

@@ -0,0 +1,3 @@
+Cisco Nxapi GEM is supported by Cisco Partners and Cisco Systems.
+
+Please report any issues with the Cisco Nxapi gem to [https://github.com/cisco/cisco-nxapi/issues](https://github.com/cisco/cisco-nxapi/issues)

data/lib/cisco_nxapi/cisco_nxapi.rb

@@ -92,6 +92,11 @@ module CiscoNxapi
         # In this case, a username and password are mandatory
         fail TypeError if username.nil? || password.nil?
       end
+      # The default read time out is 60 seconds, which may be too short for
+      # scaled configuration to apply. Change it to 300 seconds, which is
+      # also used as the default config by firefox.
+      @http.read_timeout = 300
+
       unless username.nil?
         fail TypeError, 'invalid username' unless username.is_a?(String)
         fail ArgumentError, 'empty username' unless username.length > 0
@@ -299,6 +304,9 @@ module CiscoNxapi
         # Examples: "Invalid input", "Incomplete command", etc.
         fail CliError.new(command, output['msg'], output['code'],
                           output['clierror'], prev_cmds)
+      elsif output['code'] == '413'
+        # Request too large
+        fail NxapiError.new("Error 413: #{output['msg']}")
       elsif output['code'] == '501'
         # if structured output is not supported for this command,
         # raise an exception so that the calling function can

data/lib/cisco_nxapi/version.rb

@@ -13,5 +13,5 @@
 # limitations under the License.
 
 module CiscoNxapi
-  VERSION = '0.9.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cisco_nxapi
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alex Hunsberger
@@ -12,88 +12,88 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-16 00:00:00.000000000 Z
+date: 2015-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.5.1
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.5.1
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0.32'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0.32'
 - !ruby/object:Gem::Dependency
   name: net_http_unix
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.2'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.2'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.2.1
 description: |
@@ -104,15 +104,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
+- .gitignore
+- .rubocop.yml
+- .rubocop_todo.yml
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- SUPPORT.md
 - cisco_nxapi.gemspec
 - lib/cisco_nxapi.rb
 - lib/cisco_nxapi/cisco_logger.rb
@@ -132,17 +133,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Utilities for working with Cisco NX-OS NX-API