bwapi 10.0.0 → 11.0.0.pre.550

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

@@ -1,7 +1,7 @@
 module BWAPI
   class Client
     module CommandCenter
-      # Displays module for commandcenter/scenetypes endpoints
+      # SceneTypes module for commandcenter/scenetypes endpoints
       module SceneTypes
         # Get the scene types visible to the user
         #
@@ -18,12 +18,12 @@ module BWAPI
           get "commandcenter/scenetypes/#{scene_type_id}"
         end
 
-        # Get an existing scene type
+        # Get an existing scene type sub scene types
         #
         # @param [Integer] scene_type_id the scene type id
         # @return [Hash] Specific scene type with sub scences
         def get_scene_type_with_sub_scenes(scene_type_id)
-          get "commandcenter/scenetypes/#{scene_type_id}"
+          get "commandcenter/scenetypes/#{scene_type_id}/subscenes"
         end
       end
     end

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

@@ -0,0 +1,15 @@
+module BWAPI
+  class Client
+    module CommandCenter
+      # TagColours module for commandcenter/tagColours endpoints
+      module TagColours
+        # Get colours defined for tags in current client
+        #
+        # TODO: Add parameters documentation
+        def all_tag_colours
+          get 'commandcenter/tagColours'
+        end
+      end
+    end
+  end
+end

data/lib/bwapi/client/dimensions.rb

@@ -0,0 +1,13 @@
+module BWAPI
+  class Client
+    # Dimemsions module for dimensions endpoint
+    module Dimensions
+      # Get the currently supported dimensions
+      #
+      # @return [array] Current dimensions
+      def dimensions
+        get 'dimensions'
+      end
+    end
+  end
+end

data/lib/bwapi/client/oauth.rb

@@ -61,7 +61,8 @@ module BWAPI
       # @param opts [Hash] options hash of parameters
       def oauth_request(opts = {})
         response = post('oauth/token', opts)
-        self.access_token  = response['access_token']
+        self.access_token = response['access_token']
+        self.access_token_expiry = Time.at(Time.now.to_i + response['expires_in']).iso8601
         self.refresh_token = response['refresh_token'] if application_client?
         response
       end

data/lib/bwapi/client/projects.rb

@@ -1,19 +1,20 @@
-require 'bwapi/client/projects/bulkactions'
+require 'bwapi/client/projects/bulk_actions'
 require 'bwapi/client/projects/categories'
 require 'bwapi/client/projects/data'
 require 'bwapi/client/projects/data_download'
 require 'bwapi/client/projects/demographics'
 require 'bwapi/client/projects/facebook_queries'
-require 'bwapi/client/projects/twitter_queries'
 require 'bwapi/client/projects/group'
-require 'bwapi/client/projects/signals'
-require 'bwapi/client/projects/summary'
-require 'bwapi/client/projects/sharing'
-require 'bwapi/client/projects/stream_dashboards'
 require 'bwapi/client/projects/queries'
+require 'bwapi/client/projects/query/mentionfind'
 require 'bwapi/client/projects/query_groups'
 require 'bwapi/client/projects/rules'
+require 'bwapi/client/projects/sharing'
+require 'bwapi/client/projects/signals'
+require 'bwapi/client/projects/stream_dashboards'
+require 'bwapi/client/projects/summary'
 require 'bwapi/client/projects/tags'
+require 'bwapi/client/projects/twitter_queries'
 require 'bwapi/client/projects/users'
 require 'bwapi/client/projects/workflow'
 
@@ -87,15 +88,16 @@ module BWAPI
       include BWAPI::Client::Projects::Demographics
       include BWAPI::Client::Projects::FacebookQueries
       include BWAPI::Client::Projects::Group
-      include BWAPI::Client::Projects::TwitterQueries
-      include BWAPI::Client::Projects::Signals
-      include BWAPI::Client::Projects::Summary
-      include BWAPI::Client::Projects::Sharing
-      include BWAPI::Client::Projects::StreamDashboards
       include BWAPI::Client::Projects::Queries
+      include BWAPI::Client::Projects::Query::MentionFind
       include BWAPI::Client::Projects::QueryGroups
       include BWAPI::Client::Projects::Rules
+      include BWAPI::Client::Projects::Sharing
+      include BWAPI::Client::Projects::Signals
+      include BWAPI::Client::Projects::StreamDashboards
+      include BWAPI::Client::Projects::Summary
       include BWAPI::Client::Projects::Tags
+      include BWAPI::Client::Projects::TwitterQueries
       include BWAPI::Client::Projects::Users
       include BWAPI::Client::Projects::Workflow
     end

data/lib/bwapi/client/projects/{bulkactions.rb → bulk_actions.rb}

@@ -1,5 +1,5 @@
-require 'bwapi/client/projects/bulkactions/mentions'
-require 'bwapi/client/projects/bulkactions/author'
+require 'bwapi/client/projects/bulk_actions/mentions'
+require 'bwapi/client/projects/bulk_actions/author'
 
 module BWAPI
   class Client

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

@@ -1,4 +1,14 @@
+require 'bwapi/client/projects/data/audience'
+require 'bwapi/client/projects/data/audience_activity'
+require 'bwapi/client/projects/data/channel_metrics'
+require 'bwapi/client/projects/data/emoticons'
+require 'bwapi/client/projects/data/hashtags'
+require 'bwapi/client/projects/data/headlines'
+require 'bwapi/client/projects/data/mentioned_authors'
+require 'bwapi/client/projects/data/impressions'
 require 'bwapi/client/projects/data/mentions'
+require 'bwapi/client/projects/data/owner_activity'
+require 'bwapi/client/projects/data/urls'
 require 'bwapi/client/projects/data/volume'
 
 module BWAPI
@@ -29,7 +39,17 @@ module BWAPI
           get "projects/#{project_id}/data/headlines", opts
         end
 
+        include BWAPI::Client::Projects::Data::Audience
+        include BWAPI::Client::Projects::Data::AudienceActivity
+        include BWAPI::Client::Projects::Data::ChannelMetrics
+        include BWAPI::Client::Projects::Data::Emoticons
+        include BWAPI::Client::Projects::Data::Hashtags
+        include BWAPI::Client::Projects::Data::Headlines
+        include BWAPI::Client::Projects::Data::Impressions
+        include BWAPI::Client::Projects::Data::MentionedAuthors
         include BWAPI::Client::Projects::Data::Mentions
+        include BWAPI::Client::Projects::Data::OwnerActivity
+        include BWAPI::Client::Projects::Data::Urls
         include BWAPI::Client::Projects::Data::Volume
       end
     end

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

@@ -0,0 +1,21 @@
+module BWAPI
+  class Client
+    module Projects
+      module Data
+        # Audience module for projects/data/audience endpoints
+        module Audience
+          # Get all audience data for queries broken down by a second dimension
+          #
+          # @param project_id [Integer] Id of project
+          # @param dimension_two [String] Dimension 2 value
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Hash] filter The filters to apply
+          # @return [Hash] All data audience queries mentions
+          def data_audience_queries(project_id, dimension_two, opts = {})
+            get "projects/#{project_id}/data/audience/queries/#{dimension_two}", opts
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module BWAPI
+  class Client
+    module Projects
+      module Data
+        # AudienceActivity module for projects/data/audienceActivity endpoints
+        module AudienceActivity
+          # Get all audience activity data for queries broken down by a second dimension
+          #
+          # @param project_id [Integer] Id of project
+          # @param dimension_two [String] Dimension 2 value
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Hash] filter The filters to apply
+          # @return [Hash] All data audience activity queries mentions
+          def data_audience_activity_queries(project_id, dimension_two, opts = {})
+            get "projects/#{project_id}/data/audienceActivity/queries/#{dimension_two}", opts
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module BWAPI
+  class Client
+    module Projects
+      module Data
+        # ChannelMetrics module for projects/data/channelMetrics endpoints
+        module ChannelMetrics
+          # Get all channel metrics data for queries broken down by a second dimension
+          #
+          # @param project_id [Integer] Id of project
+          # @param dimension_two [String] Dimension 2 value
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Hash] filter The filters to apply
+          # @return [Hash] All data channel metrics queries mentions
+          def data_channel_metrics_queries(project_id, dimension_two, opts = {})
+            get "projects/#{project_id}/data/channelMetrics/queries/#{dimension_two}", opts
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module BWAPI
+  class Client
+    module Projects
+      module Data
+        # Emoticons module for the /projects/{project_id}/data/emoticons endpoint
+        module Emoticons
+          # Get top n emoticons
+          #
+          # @param project_id [Integer] Id of project
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Hash] filter The filters to apply
+          # @option opts [Integer] limit The limit to return
+          # @option opts [String] orderBy Parameter to sort by
+          # @option opts [String] orderDirection Direction of sort
+          # @return [array] top n emoticons based on parameter passed
+          def data_emoticons(project_id, opts = {})
+            get "/projects/#{project_id}/data/emoticons", opts
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module BWAPI
+  class Client
+    module Projects
+      module Data
+        # Hashtags module for the /projects/{project_id}/data/hashtags endpoint
+        module Hashtags
+          # Get top n hashtags
+          #
+          # @param project_id [Integer] Id of project
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Hash] filter The filters to apply
+          # @option opts [Integer] limit The limit to return
+          # @option opts [String] orderBy Parameter to sort by
+          # @option opts [String] orderDirection Direction of sort
+          # @return [array] top n hashtags based on parameter passed
+          def data_hashtags(project_id, opts = {})
+            get "/projects/#{project_id}/data/hashtags", opts
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module BWAPI
+  class Client
+    module Projects
+      module Data
+        # Headlines module for projects/data/headlines endpoints
+        module Headlines
+          # Get mention headlines that fall within the submitted filters
+          #
+          # @param project_id [Integer] Id of project
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Hash] filter The filters to apply
+          # @return [Hash] All Mention headlines
+          def data_headlines(project_id, opts = {})
+            get "projects/#{project_id}/data/headlines", opts
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module BWAPI
+  class Client
+    module Projects
+      module Data
+        # Impressions module for projects/data/impressions endpoints
+        module Impressions
+          # Get all impressions data for queries broken down by a second dimension
+          #
+          # @param project_id [Integer] Id of project
+          # @param dimension_two [String] Dimension 2 value
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Hash] filter The filters to apply
+          # @return [Hash] All data impressions queries mentions
+          def data_impressions_queries(project_id, dimension_two, opts = {})
+            get "projects/#{project_id}/data/impressions/queries/#{dimension_two}", opts
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module BWAPI
+  class Client
+    module Projects
+      module Data
+        # MentionedAuthors module for the /projects/{project_id}/data/mentionedauthors endpoint
+        module MentionedAuthors
+          # Get top n mentioned authors
+          #
+          # @param project_id [Integer] Id of project
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Hash] filter The filters to apply
+          # @option opts [Integer] limit The limit to return
+          # @option opts [String] orderBy Parameter to sort by
+          # @option opts [String] orderDirection Direction of sort
+          # @return [array] top n mentioned_authors based on parameter passed
+          def data_mentioned_authors(project_id, opts = {})
+            get "/projects/#{project_id}/data/mentionedauthors", opts
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -31,7 +31,7 @@ module BWAPI
             patch "projects/#{project_id}/data/mentions", opts
           end
 
-          # Get mentions that fall within the submitted filters with fulltext
+          # Get mentions that fall within the submitted filters with full text
           #
           # @param project_id [Integer] Id of project
           # @param opts [Hash] options hash of parameters
@@ -42,7 +42,7 @@ module BWAPI
           # @option opts [String] orderDirection Direction of sort
           # @option opts [Integer] orderByCategory Category to sort by when orderBy category
           # @return [Hash] All Mentions
-          def data_mentions_fulltext(project_id, opts = {})
+          def data_mentions_full_text(project_id, opts = {})
             get "projects/#{project_id}/data/mentions/fulltext", opts
           end
 
@@ -61,6 +61,36 @@ module BWAPI
             get "projects/#{project_id}/data/mentions/tweets", opts
           end
 
+          # Get mentions that fall within the submitted filters for all facebook posts
+          #
+          # @param project_id [Integer] Id of project
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Hash] filter The filters to apply
+          # @option opts [Integer] page Page of projects to retrieve
+          # @option opts [Integer] pageSize Results per page of results
+          # @option opts [String] orderBy Parameter to sort by
+          # @option opts [String] orderDirection Direction of sort
+          # @option opts [Integer] orderByCategory Category to sort by when orderBy category
+          # @return [Hash] All Mentions
+          def data_mentions_facebook_posts(project_id, opts = {})
+            get "projects/#{project_id}/data/mentions/facebookposts", opts
+          end
+
+          # Get mentions that fall within the submitted filters for all facebook comments
+          #
+          # @param project_id [Integer] Id of project
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Hash] filter The filters to apply
+          # @option opts [Integer] page Page of projects to retrieve
+          # @option opts [Integer] pageSize Results per page of results
+          # @option opts [String] orderBy Parameter to sort by
+          # @option opts [String] orderDirection Direction of sort
+          # @option opts [Integer] orderByCategory Category to sort by when orderBy category
+          # @return [Hash] All Mentions
+          def data_mentions_facebook_comments(project_id, opts = {})
+            get "projects/#{project_id}/data/mentions/facebookcomments", opts
+          end
+
           include BWAPI::Client::Projects::Data::Mentions::Notes
         end
       end

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

@@ -0,0 +1,21 @@
+module BWAPI
+  class Client
+    module Projects
+      module Data
+        # OwnerActivity module for projects/data/ownerActivity endpoints
+        module OwnerActivity
+          # Get all owner activity data for queries broken down by a second dimension
+          #
+          # @param project_id [Integer] Id of project
+          # @param dimension_two [String] Dimension 2 value
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Hash] filter The filters to apply
+          # @return [Hash] All data owner activity queries mentions
+          def data_owner_activity_queries(project_id, dimension_two, opts = {})
+            get "projects/#{project_id}/data/ownerActivity/queries/#{dimension_two}", opts
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module BWAPI
+  class Client
+    module Projects
+      module Data
+        # Urls module for the /projects/{project_id}/data/urls endpoint
+        module Urls
+          # Get top n urls
+          #
+          # @param project_id [Integer] Id of project
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Hash] filter The filters to apply
+          # @option opts [Integer] limit The limit to return
+          # @option opts [String] orderBy Parameter to sort by
+          # @option opts [String] orderDirection Direction of sort
+          # @return [array] top n twitter urls based on parameter passed
+          def data_urls(project_id, opts = {})
+            get "/projects/#{project_id}/data/urls", opts
+          end
+        end
+      end
+    end
+  end
+end