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

data/lib/bwapi/client/oauth.rb

@@ -1,8 +1,9 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     # OAuth module for oauth/token endpoint
     module OAuth
-
       # Authenticate a user
       #
       # @param opts [Hash] options hash of parameters
@@ -12,7 +13,7 @@ module BWAPI
       # @option opts [String] client_secret Client secret
       # @option opts [String] client_id Client id
       # @option opts [String] force_urlencoded Force urlencoded
-      def oauth_token opts={}
+      def oauth_token(opts = {})
         opts = {
           username: username,
           password: password,
@@ -24,7 +25,7 @@ module BWAPI
 
         oauth_request opts
       end
-      alias :login :oauth_token
+      alias_method :login, :oauth_token
 
       # Refresh a authenticated users oauth_token
       #
@@ -35,7 +36,7 @@ module BWAPI
       # @option opts [String] refresh_token Users refresh token
       # @option opts [String] client_id Client id
       # @option opts [String] force_urlencoded Force urlencoded
-      def oauth_refresh_token opts={}
+      def oauth_refresh_token(opts = {})
         opts = {
           username: username,
           password: password,
@@ -47,7 +48,7 @@ module BWAPI
 
         oauth_request opts
       end
-      alias :refresh :oauth_refresh_token
+      alias_method :refresh, :oauth_refresh_token
 
       # Determines grant-type used for client
       #
@@ -60,14 +61,13 @@ module BWAPI
       # Sends a oauth request
       #
       # @param opts [Hash] options hash of parameters
-      def oauth_request opts={}
+      def oauth_request(opts = {})
         creds = post 'oauth/token', opts
         self.access_token  = creds.access_token
         self.expires_in    = creds.expires_in
         self.refresh_token = creds.refresh_token if application_client?
         creds
       end
-
     end
   end
-end
+end

data/lib/bwapi/client/ping.rb

@@ -1,43 +1,43 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     # Ping module for ping endpoints
     module Ping
-
       # Get ping checking access and available HTTP verbs
       #
       # @return [Hashie::Mash] User id and name
       def get_ping
-        get "ping"
+        get 'ping'
       end
 
       # Post ping checking access and available HTTP verbs
       #
       # @return [Hashie::Mash] User id and name
       def create_ping
-        post "ping"
+        post 'ping'
       end
 
       # Put ping checking access and available HTTP verbs
       #
       # @return [Hashie::Mash] User id and name
       def update_ping
-        put "ping"
+        put 'ping'
       end
 
       # Patch ping checking access and available HTTP verbs
       #
       # @return [Hashie::Mash] User id and name
       def patch_ping
-        patch "ping"
+        patch 'ping'
       end
 
       # Delete ping checking access and available HTTP verbs
       #
       # @return [Hashie::Mash] User id and name
       def delete_ping
-        delete "ping"
+        delete 'ping'
       end
-
     end
   end
-end
+end

data/lib/bwapi/client/projects.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'bwapi/client/projects/bulkactions'
 require 'bwapi/client/projects/categories'
 require 'bwapi/client/projects/data'
@@ -21,22 +23,21 @@ module BWAPI
   class Client
     # Projects module for projects endpoints
     module Projects
-
       # Get all projects
       #
       # @param opts [Hash] options hash of parameters
       # @option opts [Integer] page Page of results to retrieve
       # @option opts [Integer] pageSize Results per page of results
       # @return [Hashie::Mash] All projects
-      def projects opts={}
-        get "projects", opts
+      def projects(opts = {})
+        get 'projects', opts
       end
 
       # Get a specific project
       #
       # @param project_id [Integer] Id of the existing project
       # @return [Hashie::Mash] Specific project
-      def get_project project_id
+      def get_project(project_id)
         get "projects/#{project_id}"
       end
 
@@ -52,8 +53,8 @@ module BWAPI
       # @option opts [Date] creationDate Date the project was created on
       # @option opts [Integer] creationUserId User ID of the user who created the project
       # @return [Hashie::Mash] New project
-      def create_project opts={}
-        post "projects", opts
+      def create_project(opts = {})
+        post 'projects', opts
       end
 
       # Update an existing project
@@ -69,7 +70,7 @@ module BWAPI
       # @option opts [Date] creationDate Date the project was created on
       # @option opts [Integer] creationUserId User ID of the user who created the project
       # @return [Hashie::Mash] Updated project
-      def update_project project_id, opts={}
+      def update_project(project_id, opts = {})
         put "projects/#{project_id}", opts
       end
 
@@ -77,7 +78,7 @@ module BWAPI
       #
       # @param project_id [Integer] id Id of the existing project
       # @return [Hashie::Mash] Deleted project
-      def delete_project project_id
+      def delete_project(project_id)
         delete "projects/#{project_id}"
       end
 
@@ -99,7 +100,6 @@ module BWAPI
       include BWAPI::Client::Projects::Tags
       include BWAPI::Client::Projects::Users
       include BWAPI::Client::Projects::Workflow
-
     end
   end
-end
+end

data/lib/bwapi/client/projects/bulkactions.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'bwapi/client/projects/bulkactions/mentions'
 require 'bwapi/client/projects/bulkactions/author'
 
@@ -6,7 +8,6 @@ module BWAPI
     module Projects
       # BulkActions module for projects/bulkactions endpoint
       module BulkActions
-
         # Get all bulk actions in project
         #
         # @param project_id [Integer] Id of project
@@ -15,14 +16,13 @@ module BWAPI
         # @option opts [Integer] pageSize Results per page of results
         # @option opts [String] sinceDate the start date to get bulk actions from
         # @return [Hashie::Mash] All bulk actions in project
-        def bulk_actions project_id, opts={}
+        def bulk_actions(project_id, opts = {})
           get "projects/#{project_id}/bulkactions", opts
         end
 
         include BWAPI::Client::Projects::BulkActions::Mentions
         include BWAPI::Client::Projects::BulkActions::Author
-
       end
     end
   end
-end
+end

data/lib/bwapi/client/projects/bulkactions/author.rb

@@ -1,10 +1,11 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module Projects
       module BulkActions
         # Author module for projects/bulkactions/author endpoints
         module Author
-
           # Create a new bulk action in project for an author
           #
           # @param project_id [Integer] Id of project
@@ -17,11 +18,11 @@ module BWAPI
           # @option opts [Array] interests list<String> Interests to assign
           # @option opts [Array] professions list<AuthorProfessionDTO> Professions to assign
           # @return [Hashie::Mash] New bulk action for mentions
-          def bulk_edit_author project_id, opts={}
+          def bulk_edit_author(project_id, opts = {})
             post "projects/#{project_id}/bulkactions/author", opts
           end
         end
       end
     end
   end
-end
+end

data/lib/bwapi/client/projects/bulkactions/mentions.rb

@@ -1,10 +1,11 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module Projects
       module BulkActions
         # Mentions module for projects/bulkactions/mentions endpoints
         module Mentions
-
           # Create a new bulk action in project for mentions
           #
           # @param project_id [Integer] Id of project
@@ -13,11 +14,11 @@ module BWAPI
           # @option opts [Hash] filter <filter dto> to specify what kind of mentions this bulk action should apply to
           # @option opts [Integer] sampleAmount Amount to be sample by this bulk action
           # @return [Hashie::Mash] New bulk action for mentions
-          def bulk_edit_mentions project_id, opts={}
+          def bulk_edit_mentions(project_id, opts = {})
             post "projects/#{project_id}/bulkactions/mentions", opts
           end
         end
       end
     end
   end
-end
+end

data/lib/bwapi/client/projects/categories.rb

@@ -1,9 +1,9 @@
+# encoding: utf-8
 module BWAPI
   class Client
     module Projects
       # Categories module for projects/categories endpoints
       module Categories
-
         # Get all categories in project
         #
         # @param project_id [Integer] Id of project
@@ -11,22 +11,10 @@ module BWAPI
         # @option opts [Integer] page Page of projects to retrieve
         # @option opts [Integer] pageSize Results per page of results
         # @return [Hashie::Mash] All categories in project
-        def categories project_id, opts={}
+        def categories(project_id, opts = {})
           get "projects/#{project_id}/categories", opts
         end
 
-        # TODO: Uncomment this code when endpoint is created
-        #
-        # Get a specific category in project
-        #
-        # @param project_id [Integer] Id of project
-        # @param category_id [Integer] Id of category
-        # @return [Hashie::Mash] Specific category
-        #def get_category project_id, category_id
-        #  get "projects/#{project_id}/categories/#{category_id}", opts
-        #end
-        #alias :category :get_category
-
         # Create a new category in project
         #
         # @param project_id [Integer] Id of project
@@ -36,7 +24,7 @@ module BWAPI
         # @option opts [Array] children The children of the category
         # @option opts [Boolean] multiple Whether multiple sub categories can be selected
         # @return [Hashie::Mash] New category
-        def create_category project_id, opts={}
+        def create_category(project_id, opts = {})
           post "projects/#{project_id}/categories", opts
         end
 
@@ -50,21 +38,19 @@ module BWAPI
         # @option opts [Array] children The children of the category
         # @option opts [Boolean] multiple Whether multiple sub categories can be selected
         # @return [Hashie::Mash] Updated category
-        def update_category project_id, category_id, opts={}
+        def update_category(project_id, category_id, opts = {})
           put "projects/#{project_id}/categories/#{category_id}", opts
         end
 
-
         # Delete and existing category in project
         #
         # @param project_id [Integer] Id of project
         # @param category_id [Integer] Id of query group
         # @return [Hashie::Mash] Deleted category
-        def delete_category project_id, category_id
+        def delete_category(project_id, category_id)
           delete "projects/#{project_id}/categories/#{category_id}"
         end
-
       end
     end
   end
-end
+end

data/lib/bwapi/client/projects/data.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'bwapi/client/projects/data/mentions'
 require 'bwapi/client/projects/data/volume'
 
@@ -6,7 +7,6 @@ module BWAPI
     module Projects
       # Data module for projects/data endpoints
       module Data
-
         # Get all chart data for the requested dimensions
         #
         # @param project_id [Integer] Id of project
@@ -16,7 +16,7 @@ module BWAPI
         # @param opts [Hash] options hash of parameters
         # @option opts [Hash] filter The filters to apply
         # @return [Hashie::Mash] All Chart data mentions
-        def data project_id, aggregate, dimension_one, dimension_two, opts={}
+        def data(project_id, aggregate, dimension_one, dimension_two, opts = {})
           get "projects/#{project_id}/data/#{aggregate}/#{dimension_one}/#{dimension_two}", opts
         end
 
@@ -26,14 +26,13 @@ module BWAPI
         # @param opts [Hash] options hash of parameters
         # @option opts [Hash] filter The filters to apply
         # @return [Hashie::Mash] Headline figures for spedified channels
-        def data_headlines project_id, opts={}
+        def data_headlines(project_id, opts = {})
           get "projects/#{project_id}/data/headlines", opts
         end
 
         include BWAPI::Client::Projects::Data::Mentions
         include BWAPI::Client::Projects::Data::Volume
-
       end
     end
   end
-end
+end

data/lib/bwapi/client/projects/data/mentions.rb

@@ -1,10 +1,11 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module Projects
       module Data
         # Mentions module for projects/data/mentions endpoints
         module Mentions
-
           # Get mentions that fall within the submitted filters
           #
           # @param project_id [Integer] Id of project
@@ -16,7 +17,7 @@ module BWAPI
           # @option opts [String] orderDirection Direction of sort
           # @option opts [Integer] orderByCategory Category to sort by when orderBy category
           # @return [Hashie::Mash] All Mentions
-          def data_mentions project_id, opts={}
+          def data_mentions(project_id, opts = {})
             get "projects/#{project_id}/data/mentions", opts
           end
 
@@ -26,7 +27,7 @@ module BWAPI
           # @param opts [Hash] options hash of parameters
           # @option opts [Hash] List The patches to be applied
           # @return [Hashie::Mash] Updated mentions
-          def update_data_mentions project_id, opts={}
+          def update_data_mentions(project_id, opts = {})
             patch "projects/#{project_id}/data/mentions", opts
           end
 
@@ -41,7 +42,7 @@ module BWAPI
           # @option opts [String] orderDirection Direction of sort
           # @option opts [Integer] orderByCategory Category to sort by when orderBy category
           # @return [Hashie::Mash] All Mentions
-          def data_mentions_fulltext project_id, opts={}
+          def data_mentions_fulltext(project_id, opts = {})
             get "projects/#{project_id}/data/mentions/fulltext", opts
           end
 
@@ -56,12 +57,11 @@ module BWAPI
           # @option opts [String] orderDirection Direction of sort
           # @option opts [Integer] orderByCategory Category to sort by when orderBy category
           # @return [Hashie::Mash] All Mentions
-          def data_mentions_tweets project_id, opts={}
+          def data_mentions_tweets(project_id, opts = {})
             get "projects/#{project_id}/data/mentions/tweets", opts
           end
-
         end
       end
     end
   end
-end
+end

data/lib/bwapi/client/projects/data/volume.rb

@@ -1,10 +1,11 @@
+# encoding: utf-8
+
 module BWAPI
   class Client
     module Projects
       module Data
         # Volume module for projects/data/volume endpoints
         module Volume
-
           # Get all chart data for date ranges broken down by days
           #
           # @param project_id [Integer] Id of project
@@ -12,7 +13,7 @@ module BWAPI
           # @option opts [Hash] filter The filters to apply
           # @option opts [Array] dateRanges Date range ids
           # @return [Hashie::Mash] All Chart data mentions
-          def data_volume_date_ranges_days project_id, opts={}
+          def data_volume_date_ranges_days(project_id, opts = {})
             get "projects/#{project_id}/data/volume/dataRanges/days", opts
           end
 
@@ -20,7 +21,7 @@ module BWAPI
           #
           # @param project_id [Integer] Id of project
           # @option opts [Hash] filter The filters to apply
-          def data_volume_queries_top_sites project_id, opts={}
+          def data_volume_queries_top_sites(project_id, opts = {})
             get "projects/#{project_id}/data/volume/queries/topsites", opts
           end
 
@@ -35,7 +36,7 @@ module BWAPI
           # @option opts [Integer] minVolume The minimum volume (number of mentions) for a topic to be returned
           # @option opts [Integer] limit The limit to return
           # @option opts [Integer] sampleSize The sample size
-          def data_volume_topics_compare project_id, criteria, opts={}
+          def data_volume_topics_compare(project_id, criteria, opts = {})
             get "projects/#{project_id}/data/volume/topics/compare/#{criteria}", opts
           end
 
@@ -46,7 +47,7 @@ module BWAPI
           # @option opts [Integer] limit The limit to return
           # @option opts [String] orderBy Parameter to sort by
           # @option opts [String] orderDirection Direction of sort
-          def data_volume_topics_queries project_id, opts={}
+          def data_volume_topics_queries(project_id, opts = {})
             get "projects/#{project_id}/data/volume/topics/queries", opts
           end
 
@@ -57,7 +58,7 @@ module BWAPI
           # @option opts [Integer] limit The limit to return
           # @option opts [String] orderBy Parameter to sort by
           # @option opts [String] orderDirection Direction of sort
-          def data_volume_top_authors_queries project_id, opts={}
+          def data_volume_top_authors_queries(project_id, opts = {})
             get "projects/#{project_id}/data/volume/topauthors/queries", opts
           end
 
@@ -68,7 +69,7 @@ module BWAPI
           # @option opts [Integer] limit The limit to return
           # @option opts [String] orderBy Parameter to sort by
           # @option opts [String] orderDirection Direction of sort
-          def data_volume_top_authors_queries_alt project_id, opts={}
+          def data_volume_top_authors_queries_alt(project_id, opts = {})
             get "projects/#{project_id}/data/volume/topauthors/queries/alt", opts
           end
 
@@ -79,7 +80,7 @@ module BWAPI
           # @option opts [Integer] limit The limit to return
           # @option opts [String] orderBy Parameter to sort by
           # @option opts [String] orderDirection Direction of sort
-          def data_volume_top_sites_queries project_id, opts={}
+          def data_volume_top_sites_queries(project_id, opts = {})
             get "projects/#{project_id}/data/volume/topsites/queries", opts
           end
 
@@ -90,12 +91,11 @@ module BWAPI
           # @option opts [Integer] limit The limit to return
           # @option opts [String] orderBy Parameter to sort by
           # @option opts [String] orderDirection Direction of sort
-          def data_volume_top_tweeters_queries project_id, opts={}
+          def data_volume_top_tweeters_queries(project_id, opts = {})
             get "projects/#{project_id}/data/volume/toptweeters/queries", opts
           end
-
         end
       end
     end
   end
-end
+end