linodeapi 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bb89d05c98ea7f75197a191ff416262b6264c32
-  data.tar.gz: cb9ee0b2f15d1fbd7c5434502e4d37c126be1edd
+  metadata.gz: 6394f88d9c7358a4903ea5245de4916b3d0318c6
+  data.tar.gz: 4fc2de46d5e3aaf95844b4720bda4285e81f7ba4
 SHA512:
-  metadata.gz: 4cbd8c6355395392e01ddae32c7392cee3950bbbbd2b00c59b8085cc86c5047b5eb2e750e09795767f952f9832e4289ab9b068d2afd6c4479570496c521fb036
-  data.tar.gz: 4dc00e59bbb2d9186f9e33bbf969d290ecd5002d7db33292c4c6f1286d998355079d3c66865dfafc2191b26f2cde2f539184f5ef739e8a97815a253ef5c1fd04
+  metadata.gz: f9364ea374b898fa6035724c49233f74b003a7732d0f047d3b386eae0a1c9da9be8ffb39560f08d99f9b923afbd2121932d55de4b27a104d261cd4a2be9de711
+  data.tar.gz: 9e90e89aea6e51a67bad8cbed56c8b277c01a4aaed11d292020af15596d10e3cd09b1de5c5deacc2d597b6185b4794f49a18c827e4836f2f78de19e62763ca6b

data/README.md

@@ -12,6 +12,48 @@ Ruby API wrapper for the [Linode API](https://www.linode.com/api)
 
 ## Usage
 
+Create an API object from the LinodeAPI::Raw class, by providing it with either an API key or username and password:
+
+```
+require 'linodeapi'
+
+api_one = LinodeAPI::Raw(apikey: 'YOUR_KEY_HERE')
+api_two = LinodeAPI::Raw(username: 'akerl', password: 'cyberpond')
+```
+
+The Raw API object is a faithful representation of Linode's [API spec](https://www.linode.com/api/utility/api.spec), parsed directly from the upstream source at runtime. Calls can be made using the methods shown in Linode's [API docs](https://www.linode.com/api):
+
+```
+# cat list.rb
+require 'linodeapi'
+
+api = LinodeAPI::Raw.new(apikey: 'KEY')
+
+result = api.linode.list
+
+puts "#{result.size} Linodes found: #{result.map(&:label).join(', ')}"
+p result.first
+```
+
+```
+# ruby list.rb
+6 Linodes found: miro, olhado, quara, grego, ela, quim
+#<OpenStruct alert_cpu_enabled=0, alert_bwin_enabled=0, alert_bwquota_enabled=0, alert_diskio_threshold=1000, backupwindow=4, watchdog=1, distributionvendor="Arch", datacenterid=6, status=1, alert_diskio_enabled=0, create_dt="2014-07-30 20:09:12.0", totalhd=49152, alert_bwquota_threshold=80, totalram=2048, alert_bwin_threshold=5, linodeid=591319, alert_bwout_threshold=5, alert_bwout_enabled=0, backupsenabled=0, alert_cpu_threshold=90, planid=2, backupweeklyday=0, label="miro", lpm_displaygroup="cluster", totalxfer=3000>
+```
+
+Arguments passed in are named just like in the docs:
+
+```
+api.linode.ip.list(linodeid: 591319)
+```
+
+The library will raise an exception if you exclude a required parameter:
+
+```
+api.linode.create
+# ArgumentError: linode.create requires planid
+```
+
 ## Installation
 
     gem install linodeapi

data/dev/spec.yml

@@ -80,6 +80,10 @@ avail:
   kernels:
   - desc: List available kernels.
   - params:
+    - iskvm:
+      - desc: Limits the results to show only KVM kernels
+      - required: false
+      - type: :boolean
     - isxen:
       - desc: Limits the results to show only Xen kernels
       - required: false
@@ -479,14 +483,18 @@ linode:
         - desc: Enable the disableUpdateDB filesystem helper
         - required: false
         - type: :boolean
+      - helper_distro:
+        - desc: Enable the Distro filesystem helper.  Corrects fstab and inittab/upstart
+            entries depending on the kernel you're booting.  You want this.
+        - required: false
+        - type: :boolean
       - helper_network:
         - desc: Automatically creates network configuration files for your distro
             and places them into your filesystem.
         - required: false
         - type: :boolean
       - helper_xen:
-        - desc: Enable the Xen filesystem helper.  Corrects fstab and inittab/upstart
-            entries depending on the kernel you're booting.  You want this.
+        - desc: Deprecated - use helper_distro.
         - required: false
         - type: :boolean
       - kernelid:
@@ -522,6 +530,10 @@ linode:
         - desc: 'One of ''default'', ''single'', ''binbash'' '
         - required: false
         - type: :string
+      - virt_mode:
+        - desc: 'Controls the virtualization mode. One of ''paravirt'', ''fullvirt'' '
+        - required: false
+        - type: :string
     - throws:
       - NOTFOUND
       - VALIDATION
@@ -580,14 +592,18 @@ linode:
         - desc: Enable the disableUpdateDB filesystem helper
         - required: false
         - type: :boolean
+      - helper_distro:
+        - desc: Enable the Distro filesystem helper.  Corrects fstab and inittab/upstart
+            entries depending on the kernel you're booting.  You want this.
+        - required: false
+        - type: :boolean
       - helper_network:
         - desc: Automatically creates network configuration files for your distro
             and places them into your filesystem.
         - required: false
         - type: :boolean
       - helper_xen:
-        - desc: Enable the Xen filesystem helper.  Corrects fstab and inittab/upstart
-            entries depending on the kernel you're booting.  You want this.
+        - desc: Deprecated - use helper_distro.
         - required: false
         - type: :boolean
       - kernelid:
@@ -623,6 +639,10 @@ linode:
         - desc: 'One of ''default'', ''single'', ''binbash'' '
         - required: false
         - type: :string
+      - virt_mode:
+        - desc: 'Controls the virtualization mode. One of ''paravirt'', ''fullvirt'' '
+        - required: false
+        - type: :string
     - throws:
       - NOTFOUND
       - VALIDATION
@@ -1174,13 +1194,19 @@ nodebalancer:
         - required: false
         - type: :string
       - check_body:
-        - desc: When check=http_body, a regex against the expected result body
+        - desc: When check=http, a regex to match within the first 16,384 bytes of
+            the response body
         - required: false
         - type: :string
       - check_interval:
         - desc: Seconds between health check probes.  2-3600
         - required: false
         - type: :numeric
+      - check_passive:
+        - desc: Enable passive checks based on observing communication with back-end
+            nodes.
+        - required: false
+        - type: :boolean
       - check_path:
         - desc: When check=http, the path to request
         - required: false
@@ -1261,13 +1287,19 @@ nodebalancer:
         - required: false
         - type: :string
       - check_body:
-        - desc: When check=http_body, a regex against the expected result body
+        - desc: When check=http, a regex to match within the first 16,384 bytes of
+            the response body
         - required: false
         - type: :string
       - check_interval:
         - desc: Seconds between health check probes.  2-3600
         - required: false
         - type: :numeric
+      - check_passive:
+        - desc: Enable passive checks based on observing communication with back-end
+            nodes.
+        - required: false
+        - type: :boolean
       - check_path:
         - desc: When check=http, the path to request
         - required: false
@@ -1440,6 +1472,117 @@ nodebalancer:
   - throws:
     - NOTFOUND
     - VALIDATION
+professionalservices:
+  scope:
+    create:
+    - desc: Creates a new Professional Services scope submission
+    - params:
+      - application_quantity:
+        - desc: How many separate applications or websites are involved in this migration?
+        - required: false
+        - type: :string
+      - content_management:
+        - desc: Centralized interfaces for editing, organizing, and publishing content
+        - required: false
+        - type: :string
+      - crossover:
+        - desc: These can assist in providing reliable crossover--failures of individual
+            components can be transparent to the application.
+        - required: false
+        - type: :string
+      - current_provider:
+        - desc: ''
+        - required: false
+        - type: :string
+      - customer_name:
+        - desc: ''
+        - required: false
+        - type: :string
+      - database_server:
+        - desc: Generally used by applications to provide an organized way to capture
+            and manipulate data
+        - required: false
+        - type: :string
+      - email_address:
+        - desc: ''
+        - required: false
+        - type: :string
+      - linode_datacenter:
+        - desc: Which datacenters would you like your Linodes to be deployed in?
+        - required: false
+        - type: :string
+      - linode_plan:
+        - desc: Which Linode plans would you like to deploy?
+        - required: false
+        - type: :string
+      - mail_filtering:
+        - desc: Services here manipulate recieved messages in various ways
+        - required: false
+        - type: :string
+      - mail_retrieval:
+        - desc: User mail clients connect to these to retrieve delivered mail
+        - required: false
+        - type: :string
+      - mail_transfer:
+        - desc: Mail transfer agents facilitate message transfer between servers
+        - required: false
+        - type: :string
+      - managed:
+        - desc: ''
+        - required: false
+        - type: :string
+      - monitoring:
+        - desc: Constant monitoring of your deployed systems--these can also provide
+            automatic notifications for service failures.
+        - required: false
+        - type: :string
+      - notes:
+        - desc: ''
+        - required: false
+        - type: :string
+      - phone_number:
+        - desc: ''
+        - required: false
+        - type: :string
+      - provider_access:
+        - desc: What types of server access do you have at your current provider?
+        - required: false
+        - type: :string
+      - replication:
+        - desc: Redundant services often have shared state--replication automatically
+            propagates state changes between individual components.
+        - required: false
+        - type: :string
+      - requested_service:
+        - desc: ''
+        - required: false
+        - type: :string
+      - server_quantity:
+        - desc: How many separate servers are involved in this migration?
+        - required: false
+        - type: :string
+      - system_administration:
+        - desc: Various web interfaces for performing system administration tasks
+        - required: false
+        - type: :string
+      - ticket_number:
+        - desc: ''
+        - required: false
+        - type: :string
+      - web_cache:
+        - desc: Caching mechanisms provide temporary storage for web requests--cached
+            content can generally be retrieved faster.
+        - required: false
+        - type: :string
+      - web_server:
+        - desc: These provide network protocol handling for hosting websites.
+        - required: false
+        - type: :string
+      - webmail:
+        - desc: Access and administrate mail via web interfaces
+        - required: false
+        - type: :string
+    - throws: []
 stackscript:
   create:
   - desc: Create a StackScript.
@@ -1558,6 +1701,6 @@ user:
       - type: :string
   - throws:
     - AUTHFAIL
-    - " NEEDTOKEN"
-    - " PASSWORDEXPIRED"
-    - " KEYLIMIT"
+    - NEEDTOKEN
+    - PASSWORDEXPIRED
+    - KEYLIMIT

data/lib/linodeapi.rb

@@ -10,13 +10,6 @@ module LinodeAPI
   SPEC_URL = 'https://api.linode.com/?api_action=api.spec'
 
   class << self
-    ##
-    # Insert a helper .new() method for creating a new API object
-
-    def new(*args)
-      self::API.new(*args)
-    end
-
     def spec
       @spec ||= { type: :group, subs: fetch_spec }
     end

data/linodeapi.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'linodeapi'
-  s.version     = '0.1.1'
+  s.version     = '0.2.0'
   s.date        = Time.now.strftime("%Y-%m-%d")
 
   s.summary     = 'Linode API wrapper'
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'httparty', '~> 0.13.1'
 
-  s.add_development_dependency 'rubocop', '~> 0.32.0'
+  s.add_development_dependency 'rubocop', '~> 0.33.0'
   s.add_development_dependency 'rake', '~> 10.4.0'
   s.add_development_dependency 'coveralls', '~> 0.8.0'
   s.add_development_dependency 'rspec', '~> 3.3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linodeapi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Les Aker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-28 00:00:00.000000000 Z
+date: 2015-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.32.0
+        version: 0.33.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.32.0
+        version: 0.33.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -125,7 +125,6 @@ files:
 - dev/cache_spec.rb
 - dev/spec.yml
 - lib/linodeapi.rb
-- lib/linodeapi/api.rb
 - lib/linodeapi/raw.rb
 - linodeapi.gemspec
 - spec/linodeapi_spec.rb

data/lib/linodeapi/api.rb

@@ -1,7 +0,0 @@
-##
-# Friendlier Ruby interface to the Linode API
-
-module LinodeAPI
-  class API
-  end
-end