leaseweb-rest-api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 34dea10ae2f0597b72103f1b8339f37a2681fdbe
+  data.tar.gz: 38d1cde3510a32169959c090eb1df6fd7d992b79
+SHA512:
+  metadata.gz: bbb40bf07d621c1ed2937b4953fe09e458ff30ea0397e5ad7960ce6c99b8eae4f5a416a216e245576ffec30e8f77e3a6e6dc7b8251773a312633577bcc5ff3f3
+  data.tar.gz: 17b9a6e09e68e588c13045e00986cea88fd4bb78354df31fe0f122a6d6887170389ba5200a3d062a39c8d743ade26642ce1d72906a2ec13cad40ab668f2d8d22

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {2015} {Arnoud Vermeer}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/leaseweb-rest-api.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name          = 'leaseweb-rest-api'
+  s.version       = '1.0.0'
+  s.authors       = 'Arnoud Vermeer'
+  s.email         = 'a.vermeer@tech.leaseweb.com'
+  s.license       = 'Apache'
+  s.summary       = 'Leaseweb REST API client for Ruby'
+  s.description   = 'Leaseweb REST API client for Ruby.'
+  s.homepage      = 'https://github.com/funzoneq/leaseweb-rest-api'
+
+  s.files         = `git ls-files`.split("\n")
+
+  s.add_dependency 'httparty'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'webmock'
+end

data/lib/hash-to-uri-conversion.rb

@@ -0,0 +1,32 @@
+class HashToURIConversion
+  def to_params(hash)
+    params = hash.map { |k,v| normalize_param(k,v) }.join
+    params.chop! # trailing &
+    params
+  end
+
+  def normalize_param(key, value)
+    param = ''
+    stack = []
+
+    if value.is_a?(Array)
+      param << value.each_with_index.map { |element, i| normalize_param("#{key}[#{i}]", element) }.join
+    elsif value.is_a?(Hash)
+      stack << [key,value]
+    else
+      param << "#{key}=#{URI.encode(value.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))}&"
+    end
+
+    stack.each do |parent, hash|
+      hash.each do |k, v|
+        if v.is_a?(Hash)
+          stack << ["#{parent}[#{k}]", v]
+        else
+          param << normalize_param("#{parent}[#{k}]", v)
+        end
+      end
+    end
+
+    param
+  end
+end

data/lib/leaseweb-rest-api.rb

@@ -0,0 +1,280 @@
+#!/usr/bin/env ruby
+
+require 'httparty'
+require 'base64'
+require 'time'
+require_relative 'hash-to-uri-conversion'
+
+class LeasewebAPI
+  include HTTParty
+  format :json
+  #debug_output $stderr
+
+  base_uri 'https://api.leaseweb.com/v1'
+
+  def initialize (apikey, privateKey, password)
+    @options = { headers: { "X-Lsw-Auth" => apikey } }
+    @private_key = OpenSSL::PKey::RSA.new(File.read(privateKey),password)
+  end
+
+  # Domains
+  def getDomains
+    self.class.get("/domains", @options)
+  end
+
+  def getDomain(domain)
+    self.class.get("/domains/#{domain}", @options)
+  end
+
+  def updateDomain(domain, ttl)
+    opt = @options.merge!({ :body => { :ttl => ttl } })
+
+    self.class.put("/domains/#{domain}", opt)
+  end
+
+  def getDNSRecords(domain)
+    self.class.get("/domains/#{domain}/dnsRecords", @options)
+  end
+
+  def createDNSRecords(domain, host, content, type, priority = nil)
+    opt = @options.merge!({ :body => { :host => host, :content => content, :type => type } })
+
+    if not priority.nil? and (type == 'MX' or type == 'SRV')
+      opt[:body][:priority] = priority
+    end
+
+    self.class.post("/domains/#{domain}/dnsRecords", opt)
+  end
+
+  def getDNSRecord(domain, dnsRecordId)
+    self.class.get("/domains/#{domain}/dnsRecords/#{dnsRecordId}", @options)
+  end
+
+  def updateDNSRecord(domain, dnsRecordId, host, content, type, priority = nil)
+    opt = @options.merge!({ :body => { :id => dnsRecordId, :host => host, :content => content, :type => type } })
+
+    if not priority.nil? and (type == 'MX' or type == 'SRV')
+      opt[:body][:priority] = priority
+    end
+
+    self.class.put("/domains/#{domain}/dnsRecords/#{dnsRecordId}", opt)
+  end
+
+  def deleteDNSRecord(domain, dnsRecordId)
+    self.class.delete("/domains/#{domain}/dnsRecords/#{dnsRecordId}", @options)
+  end
+
+  # Rescue
+  def getRescueImages
+    self.class.get("/rescueImages", @options)
+  end
+
+  # BareMetals
+  def getBareMetals
+    self.class.get("/bareMetals", @options)
+  end
+
+  def getBareMetal(bareMetalId)
+    self.class.get("/bareMetals/#{bareMetalId}", @options)
+  end
+
+  def updateBareMetal(bareMetalId, reference)
+    opt = @options.merge!({ :body => { :reference => reference } })
+
+    self.class.put("/bareMetals/#{bareMetalId}", opt)
+  end
+
+  def getSwitchPort(bareMetalId)
+    self.class.get("/bareMetals/#{bareMetalId}/switchPort", @options)
+  end
+
+  def postSwitchPortOpen(bareMetalId)
+    self.class.post("/bareMetals/#{bareMetalId}/switchPort/open", @options)
+  end
+
+  def postSwitchPortClose(bareMetalId)
+    self.class.post("/bareMetals/#{bareMetalId}/switchPort/close", @options)
+  end
+
+  def getPowerStatus(bareMetalId)
+    self.class.get("/bareMetals/#{bareMetalId}/powerStatus", @options)
+  end
+
+  def getIPs(bareMetalId)
+    self.class.get("/bareMetals/#{bareMetalId}/ips", @options)
+  end
+
+  def getIP(bareMetalId, ipAddress)
+    self.class.get("/bareMetals/#{bareMetalId}/ips/#{ipAddress}", @options)
+  end
+
+  def updateIP(bareMetalId, ipAddress, reverseLookup='', nullRouted=0)
+    opt = @options.merge!({ :body => { :reverseLookup => reverseLookup, :nullRouted => nullRouted } })
+
+    self.class.put("/bareMetals/#{bareMetalId}/ips/#{ipAddress}", opt)
+  end
+
+  def getNetworkUsage(bareMetalId)
+    self.class.get("/bareMetals/#{bareMetalId}/networkUsage", @options)
+  end
+
+  def getNetworkUsageBandWidth(bareMetalId, dateFrom, dateTo, format='json')
+    self.class.get("/bareMetals/#{bareMetalId}/networkUsage/bandWidth", formatRequest(dateFrom, dateTo, format))
+  end
+
+  def getNetworkUsageDataTraffic(bareMetalId, dateFrom, dateTo, format='json')
+    self.class.get("/bareMetals/#{bareMetalId}/networkUsage/dataTraffic", formatRequest(dateFrom, dateTo, format))
+  end
+
+  def postReboot(bareMetalId)
+    self.class.post("/bareMetals/#{bareMetalId}/reboot", @options)
+  end
+
+  def installServer(bareMetalId, osId, hdd = [])
+    opt = @options.merge!({ :body => { :osId => osId, :hdd => hdd }, query_string_normalizer: ->(h){ HashToURIConversion.new().to_params(h) } })
+
+    self.class.post("/bareMetals/#{bareMetalId}/install", opt)
+  end
+
+  def postResqueMode(bareMetalId, osId)
+    opt = @options.merge!({ :body => { :osId => osId } })
+
+    self.class.post("/bareMetals/#{bareMetalId}/rescueMode", opt)
+  end
+
+  def getRootPassword(bareMetalId, format='json')
+    opt = @options.merge!({ :headers => self.formatHeader(format) })
+
+    self.class.get("/bareMetals/#{bareMetalId}/rootPassword", opt)
+  end
+
+  def getInstallationStatus(bareMetalId)
+    response = self.class.get("/bareMetals/#{bareMetalId}/installationStatus", @options)
+
+    if response["installationStatus"].include?('initRootPassword')
+      response["installationStatus"]["initRootPassword"] = self.decrypt(response["installationStatus"]["initRootPassword"])
+    end
+
+    if response["installationStatus"].include?('rescueModeRootPass')
+      response["installationStatus"]["rescueModeRootPass"] = self.decrypt(response["installationStatus"]["rescueModeRootPass"])
+    end
+
+    response
+  end
+
+  def getLeases(bareMetalId)
+    self.class.get("/bareMetals/#{bareMetalId}/leases", @options)
+  end
+
+  def setLease(bareMetalId, bootFileName)
+    opt = @options.merge!({ :body => { :bootFileName => bootFileName } })
+
+    self.class.post("/bareMetals/#{bareMetalId}/leases", opt)
+  end
+
+  def getLease(bareMetalId, macAddress)
+    self.class.get("/bareMetals/#{bareMetalId}/leases/#{macAddress}", @options)
+  end
+
+  def deleteLease(bareMetalId, macAddress)
+    self.class.delete("/bareMetals/#{bareMetalId}/leases/#{macAddress}", @options)
+  end
+
+  # Private Networks
+  def getPrivateNetworks
+    self.class.get("/privateNetworks", @options)
+  end
+
+  # TODO: check post with name
+  def createPrivateNetworks(name='')
+    opt = @options.merge!({ :body => { :name => name } })
+
+    self.class.post("/privateNetworks", opt)
+  end
+
+  def getPrivateNetwork(id)
+    self.class.get("/privateNetworks/#{id}", @options)
+  end
+
+  # TODO: Check with Jeroen if it works
+  def updatePrivateNetwork(id, name='')
+    opt = @options.merge!({ :body => { :name => name } })
+
+    self.class.put("/privateNetworks/#{id}", opt)
+  end
+
+  def deletePrivateNetwork(id)
+    self.class.delete("/privateNetworks/#{id}", @options)
+  end
+
+  def createPrivateNetworksBareMetals(id, bareMetalId)
+    opt = @options.merge!({ :body => { :bareMetalId => bareMetalId } })
+
+    self.class.post("/privateNetworks/#{id}/bareMetals", opt)
+  end
+
+  def deletePrivateNetworksBareMetals(id, bareMetalId)
+    self.class.delete("/privateNetworks/#{id}/bareMetals/#{bareMetalId}", @options)
+  end
+
+  # Operating Systems
+  def getOperatingSystems
+    self.class.get("/operatingSystems", @options)
+  end
+
+  def getOperatingSystem(operatingSystemId)
+    self.class.get("/operatingSystems/#{operatingSystemId}", @options)
+  end
+
+  def getControlPanels(operatingSystemId)
+    self.class.get("/operatingSystems/#{operatingSystemId}/controlPanels", @options)
+  end
+
+  def getControlPanel(operatingSystemId, controlPanelId)
+    self.class.get("/operatingSystems/#{operatingSystemId}/controlPanels/#{controlPanelId}", @options)
+  end
+
+  def getPartitionSchema(operatingSystemId, bareMetalId)
+    opt = @options.merge!({ :query => { :serverPackId => bareMetalId } })
+
+    self.class.get("/operatingSystems/#{operatingSystemId}/partitionSchema", opt)
+  end
+
+  # IPs
+  def getIps
+    self.class.get("/ips", @options)
+  end
+
+  def getIp(ipAddress)
+    self.class.get("/ips/#{ipAddress}", @options)
+  end
+
+  def updateIp(ipAddress, reverseLookup='', nullRouted=0)
+    opt = @options.merge!({ :body => { :reverseLookup => reverseLookup, :nullRouted => nullRouted } })
+
+    self.class.put("/ips/#{ipAddress}", opt)
+  end
+
+  protected
+  def decrypt(string)
+    @private_key.private_decrypt(Base64.decode64(string))
+  end
+
+  def dateFormat(date)
+    Date.parse(date).strftime('%d-%m-%Y')
+  end
+
+  def formatHeader(format)
+    if format == 'json'
+      header = { 'Accept' => 'application/json' }.merge!(@options[:headers])
+    else
+      header = { 'Accept' => 'image/png' }.merge!(@options[:headers])
+    end
+
+    header
+  end
+
+  def formatRequest(dateFrom, dateTo, format)
+    @options.merge!({ :query => { :dateFrom => self.dateFormat(dateFrom), :dateTo => self.dateFormat(dateTo) }, :headers => self.formatHeader(format) })
+  end
+end