bwapi 6.5.0.pre.256 → 7.0.0.pre.271

data/lib/bwapi/client/command_center/displays/screens.rb

@@ -1,15 +1,16 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module CommandCenter
       module Displays
         # Displays module for commandcenter/displays/screens endpoints
         module Screens
-
           # Get the screens for a display
           #
           # @param [Integer] display_id The display id
           # @return [Hashie::Mash] All screens for display
-          def screens display_id
+          def screens(display_id)
             get "commandcenter/displays/#{display_id}/screens"
           end
 
@@ -18,7 +19,7 @@ module BWAPI
           # @param [Integer] display_id The display id
           # @param [Integer] screen_id The screen id
           # @return [Hashie::Mash] Specific screen for display
-          def get_screen display_id, screen_id
+          def get_screen(display_id, screen_id)
             get "commandcenter/displays/#{display_id}/screens/#{screen_id}"
           end
 
@@ -27,7 +28,7 @@ module BWAPI
           # @param [Integer] display_id The display id
           # @param [Integer] screen_id The screen id
           # @return [Hashie::Mash] Specific screen for display with scenes
-          def get_screen_with_scenes display_id, screen_id
+          def get_screen_with_scenes(display_id, screen_id)
             get "commandcenter/displays/#{display_id}/screens/#{screen_id}/withscenes"
           end
 
@@ -43,7 +44,7 @@ module BWAPI
           # @option opts [String] created Date screen was created
           # @option opts [Boolean] enabled Whether screen is enabled
           # @return [Hashie::Mash] New display screen
-          def create_screen display_id, opts={}
+          def create_screen(display_id, opts = {})
             post "commandcenter/displays/#{display_id}/screens", opts
           end
 
@@ -59,7 +60,7 @@ module BWAPI
           # @option opts [String] created Date screen was created
           # @option opts [Boolean] enabled Whether screen is enabled
           # @return [Hashie::Mash] Updated display screen
-          def update_screen display_id, screen_id, opts={}
+          def update_screen(display_id, screen_id, opts = {})
             put "commandcenter/displays/#{display_id}/screens/#{screen_id}", opts
           end
 
@@ -68,12 +69,11 @@ module BWAPI
           # @param [Integer] display_id The display id
           # @param [Integer] screen_id The screen id
           # @return [Hashie::Mash] Deleted display screen
-          def delete_screen display_id, screen_id
+          def delete_screen(display_id, screen_id)
             delete "commandcenter/displays/#{display_id}/screens/#{screen_id}"
           end
-
         end
       end
     end
   end
-end
+end

data/lib/bwapi/client/command_center/displays/users.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'bwapi/client/command_center/displays/users/access'
 
 module BWAPI
@@ -6,20 +8,18 @@ module BWAPI
       module Displays
         # Users module for commandcenter/displays/users endpoints
         module Users
-
           # Get all users display access levels
           #
           # @return [Hashie::Mash] Display access levels
           def displays_access_levels
-            get "commandcenter/displays/users"
+            get 'commandcenter/displays/users'
           end
 
           # Get a users display access levels for displays
           #
-          # @param [Integer] display_id the display id
           # @param [Integer] user_id the user id
           # @return [Hashie::Mash] Specific display user access levels
-          def get_displays_user_access_levels display_id, user_id
+          def get_displays_user_access_levels(user_id)
             get "commandcenter/displays/users/#{user_id}"
           end
 
@@ -27,7 +27,7 @@ module BWAPI
           #
           # @param [Integer] display_id the display id
           # @return [Hashie::Mash] Specific display user access levels
-          def get_display_users_access_levels display_id
+          def get_display_users_access_levels(display_id)
             get "commandcenter/displays/#{display_id}/users"
           end
 
@@ -36,7 +36,7 @@ module BWAPI
           # @param [Integer] display_id the display id
           # @param [Integer] user_id the user id
           # @return [Hashie::Mash] Specific display and user access level
-          def get_display_user_access_levels display_id, user_id
+          def get_display_user_access_levels(display_id, user_id)
             get "commandcenter/displays/#{display_id}/users/#{user_id}"
           end
 
@@ -45,12 +45,11 @@ module BWAPI
           # @param [Integer] display_id the display id
           # @param [Integer] user_id the user id
           # @return [Hashie::Mash] Specific display and user access level
-          def delete_display_user_access_levels display_id, user_id
+          def delete_display_user_access_levels(display_id, user_id)
             delete "commandcenter/displays/#{display_id}/users/#{user_id}"
           end
 
           include BWAPI::Client::CommandCenter::Displays::Users::Access
-
         end
       end
     end

data/lib/bwapi/client/command_center/displays/users/access.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module BWAPI
   class Client
     module CommandCenter
@@ -5,14 +6,13 @@ module BWAPI
         module Users
           # Displays module for commandcenter/displays/users/access endpoints
           module Access
-
             # Grant a display user access level
             #
             # @param [Integer] display_id the display id
             # @param [Integer] user_id the user id
             # @param [Integer] access_level the access level
             # @return [Hashie::Mash] Updated user access level
-            def grant_display_user_access_level display_id, user_id, access_level
+            def grant_display_user_access_level(display_id, user_id, access_level)
               post "commandcenter/displays/#{display_id}/users/#{user_id}/access/#{access_level}"
             end
 
@@ -22,13 +22,12 @@ module BWAPI
             # @param [Integer] user_id the user id
             # @param [Integer] access_level the access level
             # @return [Hashie::Mash] Updated user access level
-            def update_display_user_access_level display_id, user_id, access_level
+            def update_display_user_access_level(display_id, user_id, access_level)
               put "commandcenter/displays/#{display_id}/users/#{user_id}/access/#{access_level}"
             end
-
           end
         end
       end
     end
   end
-end
+end

data/lib/bwapi/client/command_center/scene_types.rb

@@ -1,21 +1,22 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module CommandCenter
       # Displays module for commandcenter/scenetypes endpoints
       module SceneTypes
-
         # Get the scene types visible to the user
         #
         # @return [Hashie::Mash] All scene types
         def scene_types
-          get "commandcenter/scenetypes"
+          get 'commandcenter/scenetypes'
         end
 
         # Get an existing scene type
         #
         # @param [Integer] scene_type_id the scene type id
         # @return [Hashie::Mash] Specific scene type
-        def get_scene_type scene_type_id
+        def get_scene_type(scene_type_id)
           get "commandcenter/scenetypes/#{scene_type_id}"
         end
 
@@ -23,11 +24,10 @@ module BWAPI
         #
         # @param [Integer] scene_type_id the scene type id
         # @return [Hashie::Mash] Specific scene type with sub scences
-        def get_scene_type_with_sub_scenes scene_type_id
+        def get_scene_type_with_sub_scenes(scene_type_id)
           get "commandcenter/scenetypes/#{scene_type_id}"
         end
-
       end
     end
   end
-end
+end

data/lib/bwapi/client/command_center/themes.rb

@@ -1,17 +1,17 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module CommandCenter
       # Themes module for commandcenter/themes endpoints
       module Themes
-
         # Get themes for client
         #
         # @return [Hashie::Mash] All themes
         def themes
-          get "commandcenter/themes"
+          get 'commandcenter/themes'
         end
-
       end
     end
   end
-end
+end

data/lib/bwapi/client/command_center/users.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'bwapi/client/command_center/users/access'
 
 module BWAPI
@@ -5,19 +7,18 @@ module BWAPI
     module CommandCenter
       # Users module for commandcenter/users endpoints
       module Users
-
         # Get the access levels for all users
         #
         # @return [Hashie::Mash] All users access levels
         def users_access_levels
-          get "commandcenter/users"
+          get 'commandcenter/users'
         end
 
         # Get an existing user access level
         #
         # @param [Integer] user_id the user id
         # @return [Hashie::Mash] Specific user access level
-        def get_user_access_level user_id
+        def get_user_access_level(user_id)
           get "commandcenter/users/#{user_id}"
         end
 
@@ -25,13 +26,12 @@ module BWAPI
         #
         # @param [Integer] user_id the user id
         # @return [Hashie::Mash] Deleted user access level
-        def delete_user_access_level user_id
+        def delete_user_access_level(user_id)
           delete "commandcenter/users/#{user_id}"
         end
 
         include BWAPI::Client::CommandCenter::Users::Access
-
       end
     end
   end
-end
+end

data/lib/bwapi/client/command_center/users/access.rb

@@ -1,21 +1,21 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module CommandCenter
-      # Users module for commandcenter/users/access endpoints
       module Users
+        # Users module for commandcenter/users/access endpoints
         module Access
-
           # Update an existing user access level
           #
           # @param [Integer] user_id the user id
           # @param [Integer] access_level the access level
           # @return [Hashie::Mash] Updated user access level
-          def update_user_access_level user_id, access_level
+          def update_user_access_level(user_id, access_level)
             put "commandcenter/users/#{user_id}/access/#{access_level}"
           end
-
         end
       end
     end
   end
-end
+end

data/lib/bwapi/client/error_codes.rb

@@ -1,15 +1,15 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     # ErrorCodes module for errorCodes endpoint
     module ErrorCodes
-
       # Get the api error codes
       #
       # @return [Hashie::Mash] Error codes information
       def error_codes
-        get "errorCodes"
+        get 'errorCodes'
       end
-
     end
   end
-end
+end

data/lib/bwapi/client/filters.rb

@@ -1,15 +1,15 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     # Filters module for filters endpoint
     module Filters
-
       # Get the currently supported filters
       #
       # @return [Hashie::Mash] Current filters
       def filters
-        get "filters"
+        get 'filters'
       end
-
     end
   end
-end
+end

data/lib/bwapi/client/languages.rb

@@ -1,15 +1,15 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     # Languages module for languages endpoints
     module Languages
-
       # Get the current language list
       #
       # @return [Hashie::Mash] Languages information
       def languages
-        get "languages"
+        get 'languages'
       end
-
     end
   end
 end

data/lib/bwapi/client/location.rb

@@ -1,12 +1,13 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     # Location module for locations endpoints
     module Location
-
       # Request the information for a given location code
       #
       # @return [Hashie::Mash] Information about the location
-      def location location_code
+      def location(location_code)
         get "location/#{location_code}"
       end
 
@@ -17,10 +18,9 @@ module BWAPI
       # @option opts [Integer] page number of results to retrieve
       # @option opts [Integer] pageSize of the results to retrieve
       # @return [Hashie::Mash] The list of matching locations
-      def location_autocomplete opts={}
-        post "location/autocomplete", opts
+      def location_autocomplete(opts = {})
+        post 'location/autocomplete', opts
       end
-
     end
   end
 end

data/lib/bwapi/client/logout.rb

@@ -1,25 +1,23 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     # Logout module for logout endpoint
     module Logout
-
       # Logout user
       #
       # @return [Hashie::Mash] Logout information
       def logout
-        begin
-          get "logout"
-        ensure
-          self.access_token   = nil
-          self.refresh_token  = nil
-          self.username       = nil
-          self.password       = nil
-          self.client_id      = nil
-          self.grant_type     = nil
-          self.expires_in     = nil
-        end
+        get 'logout'
+      ensure
+        self.access_token   = nil
+        self.refresh_token  = nil
+        self.username       = nil
+        self.password       = nil
+        self.client_id      = nil
+        self.grant_type     = nil
+        self.expires_in     = nil
       end
-
     end
   end
-end
+end

data/lib/bwapi/client/me.rb

@@ -1,8 +1,9 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     # Me module for me endpoint and helper methods
     module Me
-
       # Get user information
       #
       # @return [Hashie::Mash] User information
@@ -37,7 +38,6 @@ module BWAPI
       def user_id
         me.id
       end
-
     end
   end
-end
+end

data/lib/bwapi/client/metrics.rb

@@ -1,15 +1,15 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     # Metrics module for metrics endpoints
     module Metrics
-
       # Get the current metrics list
       #
       # @return [Hashie::Mash] Metrics information
       def metrics
-        get "metrics"
+        get 'metrics'
       end
-
     end
   end
 end