bwapi 1.0.0

data/lib/bwapi/client/projects.rb

@@ -0,0 +1,94 @@
+require 'bwapi/client/projects/categories'
+require 'bwapi/client/projects/data'
+require 'bwapi/client/projects/data_download'
+require 'bwapi/client/projects/facebook_queries'
+require 'bwapi/client/projects/signals'
+require 'bwapi/client/projects/summary'
+require 'bwapi/client/projects/sharing'
+require 'bwapi/client/projects/queries'
+require 'bwapi/client/projects/query_groups'
+require 'bwapi/client/projects/tags'
+require 'bwapi/client/projects/users'
+require 'bwapi/client/projects/workflow'
+
+module BWAPI
+  class Client
+    module Projects
+
+      # Get all projects
+      #
+      # @param opts [Hash] options hash of parameters
+      # @option opts [Integer] page Page of projects to retrieve
+      # @option opts [Integer] pageSize Results per page of results
+      # @return [Hashie::Mash] All projects
+      def projects opts={}
+        projects = get "projects", opts
+      end
+
+      # Get a specific project
+      #
+      # @param id [Integer] Id of the existing project
+      # @return [Hashie::Mash] Specific project
+      def project id
+        get "projects/#{id}"
+      end
+
+      # Create new project
+      #
+      # @param opts [Hash] options hash of parameters
+      # @option opts [String] id Id of the project
+      # @option opts [String] name Name of the project
+      # @option opts [String] description Description of the project
+      # @option opts [String] clientName Client name of the project
+      # @option opts [String] clientId Client id of the project
+      # @option opts [Array] defaultIndustry Default industry of the project
+      # @option opts [Array] defaultLangCodes Default languages of the project
+      # @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
+      end
+
+      # Update an existing project
+      #
+      # @param id [Integer] id Id of the existing project
+      # @param opts [Hash] options Hash of parameters
+      # @option opts [String] id Id of the project
+      # @option opts [String] name Name of the project
+      # @option opts [String] description Description of the project
+      # @option opts [String] clientName Client name of the project
+      # @option opts [String] clientId Client id of the project
+      # @option opts [Array] defaultIndustry Default industry of the project
+      # @option opts [Array] defaultLangCodes Default languages of the project
+      # @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 id, opts
+        put "projects/#{id}", opts
+      end
+
+      # Delete an existing project
+      #
+      # @param id [Integer] id Id of the existing project
+      # @return [Hashie::Mash] Deleted project
+      def delete_project id
+        delete "projects/#{id}"
+      end
+
+      include BWAPI::Client::Projects::Categories
+      include BWAPI::Client::Projects::Data
+      include BWAPI::Client::Projects::DataDownload
+      include BWAPI::Client::Projects::FacebookQueries
+      include BWAPI::Client::Projects::Signals
+      include BWAPI::Client::Projects::Summary
+      include BWAPI::Client::Projects::Sharing
+      include BWAPI::Client::Projects::Queries
+      include BWAPI::Client::Projects::QueryGroups
+      include BWAPI::Client::Projects::Tags
+      include BWAPI::Client::Projects::Users
+      include BWAPI::Client::Projects::Workflow
+
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+module BWAPI
+  class Client
+    module Projects
+      module Categories
+
+        # Get all categories in project
+        #
+        # @param id [Integer] Id of project
+        # @param opts [Hash] options hash of parameters
+        # @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 id, opts={}
+          get "projects/#{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 id [Integer] Id of project
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] id Id of the category
+        # @option opts [String] name Name of the category
+        # @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 id, opts={}
+          post "projects/#{id}/categories", opts
+        end
+
+        # Update an existing category in project
+        #
+        # @param project_id [Integer] Id of project
+        # @param category_id [Integer] Id of category
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] projectId Id of the project
+        # @option opts [Integer] id Id of the category
+        # @option opts [String] name Name of the category
+        # @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={}
+          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
+          delete "projects/#{project_id}/categories/#{category_id}"
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+module BWAPI
+  class Client
+    module Projects
+      module Data
+
+        # Get all chart data for the requested dimensions
+        #
+        # @param id [Integer] Id of project
+        # @param aggregate [String] Aggregate value
+        # @param dimension_one [String] Dimension 1 value
+        # @param dimension_two [String] Dimension 2 value
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] projectId Id of the project
+        # @option opts [Hash] filter The filters to apply
+        # @return [Hashie::Mash] All Chart data mentions
+        def data id, aggregate, dimension_one, dimension_two, opts={}
+          get "projects/#{id}/data/#{aggregate}/#{dimension_one}/#{dimension_two}", opts
+        end
+
+        # Get all chart data for date ranges broken down by days
+        #
+        # @param id [Integer] Id of project
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] projectId Id of the project
+        # @option opts [Hash] filter The filters to apply
+        # @option opts [Array] dateRanges Date range ids
+        # @return [Hashie::Mash] All Chart data mentions
+        def data_date_ranges_days id, opts
+          get "projects/#{id}/data/volume/dataRanges/days", opts
+        end
+
+        # Get mentions that fall within the submitted filters
+        #
+        # @param id [Integer] Id of project
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] projectId Id of the project
+        # @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 [Hashie::Mash] All Mentions
+        def data_mentions id, opts={}
+          get "projects/#{id}/data/mentions", opts
+        end
+
+        # Update mentions for project
+        #
+        # @param id [Integer] Id of project
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] projectId Id of the project
+        # @option opts [Hash] List The patches to be applied
+        # @return [Hashie::Mash] Updated mentions
+        def update_data_mentions id, opts={}
+          patch "projects/#{id}/data/mentions", opts
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+module BWAPI
+  class Client
+    module Projects
+      module DataDownload
+
+        # Get all data downloads in project
+        #
+        # @param id [Integer] Id of project
+        # @option opts [Integer] page Page of projects to retrieve
+        # @option opts [Integer] pageSize Results per page of results
+        # @return [Hashie::Mash] All data downloads in project
+        def data_downloads id, opts={}
+          get "projects/#{id}/datadownload", opts
+        end
+
+        # Get a specific data download in project
+        #
+        # @param project_id [Integer] Id of project
+        # @param data_download_id [Integer] Id of data download
+        # @return [Hashie::Mash] Specific data download
+        def get_data_download project_id, data_download_id
+          get "projects/#{project_id}/datadownload#{data_download_id}"
+        end
+        alias :data_download :get_data_download
+
+        # Create a new data download in project
+        #
+        # @param id [Integer] Id of project
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] projectId Id of the project
+        # @option opts [Integer] id Id of the data download
+        # @option opts [Integer] queryId Id of the query
+        # @option opts [Int] percentComplete The percentage complete of data download
+        # @option opts [String] status The status of the download
+        # @option opts [String] queryName The query name of the data download
+        # @option opts [Date] endDate The end date of the data download
+        # @option opts [Date] requestDate The request date of the data download
+        # @option opts [String] downloadLinkXLS The link to download the XLS format
+        # @option opts [String] downloadLinkCSV The link to download the CSV format
+        # @option opts [Array] additionalColumns The additional columns for the data download
+        # @return [Hashie::Mash] New data download
+        def create_datadownload id, opts={}
+          get "projects/#{id}/datadownload", opts
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+module BWAPI
+  class Client
+    module Projects
+      module FacebookQueries
+
+        # Get all facebook queries in project
+        #
+        # @param id [Integer] Id of project
+        # @return [Hashie::Mash] All facebook queries in project
+        def facebook_queries id
+          get "projects/#{id}/facebookqueries"
+        end
+
+        # Get a specific facebook query in project
+        #
+        # @param project_id [Integer] Id of project
+        # @param query_id [Integer] Id of facebook query
+        # @return [Hashie::Mash] Specific facebook query
+        def get_facebook_queries project_id, query_id
+          get "projects/#{project_id}/facebookqueries/#{query_id}"
+        end
+        alias :facebook_query :get_facebook_queries
+
+        # Update an existing facebook query in project
+        #
+        # @param project_id [Integer] Id of project
+        # @param query_id [Integer] Id of query
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] id Id of the query
+        # @option opts [Integer] facebookPageId Id of the facebook page
+        # @option opts [String] name Name of the project
+        # @option opts [String] facebookPageName Name of the facebook page
+        # @option opts [String] facebookPageURL URL of the facebook page
+        # @option opts [Boolean] facebookCrawlComplete Facebook initial crawling status
+        # @option opts [Integer] dailyLimit Daily limit of the query
+        # @option opts [Integer] twitterLimit Twitter limit of the query
+        # @option opts [Integer] averageMonthlyMentions Average monthly mentions
+        # @option opts [String] type Query type
+        # @option opts [Array] includedTerms Included terms of terms query
+        # @option opts [Array] contextTerms Content terms of the query
+        # @option opts [Array] excludedTerms Excluded terms of thequery
+        # @option opts [Array] languages Query languages
+        # @option opts [String] twitterScreenName Tracked twitter screen name
+        # @option opts [String] industry Industry of the query
+        # @option opts [Date] creationDate Date the query was created on
+        # @option opts [Date] lastModificationDate Modification date of the query
+        # @return [Hashie::Mash] Updated query
+        def update_facebook_query project_id, query_id, opts={}
+          put "projects/#{project_id}/facebookqueries/#{query_id}", opts
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,99 @@
+require 'bwapi/client/projects/queries/backfill'
+require 'bwapi/client/projects/queries/date_range'
+require 'bwapi/client/projects/queries/mentions'
+
+module BWAPI
+  class Client
+    module Projects
+      module Queries
+
+        # Get all queries in project
+        #
+        # @param id [Integer] Id of project
+        # @return [Hashie::Mash] All queries in project
+        def queries id
+          get "projects/#{id}/queries"
+        end
+
+        # Get summary of all queries in project
+        #
+        # @param id [Integer] Id of project
+        # @return [Hashie::Mash] Summary of all queries in project
+        def queries_summary id
+          get "projects/#{id}/queries/summary"
+        end
+
+        # Get a specific query in project
+        #
+        # @param project_id [Integer] Id of project
+        # @param query_id [Integer] Id of query
+        # @return [Hashie::Mash] Specific query
+        def get_query project_id, query_id
+          get "projects/#{project_id}/queries/#{query_id}"
+        end
+        alias :query :get_query
+
+        # Create a new query in project
+        #
+        # @param id [Integer] Id of project
+        # @param opts [Hash] options hash of parameters
+        # @option opts [String] id Id of the query
+        # @option opts [String] name Name of the project
+        # @option opts [Integer] dailyLimit Daily limit of the query
+        # @option opts [Integer] twitterLimit Twitter limit of the query
+        # @option opts [Integer] averageMonthlyMentions Average monthly mentions
+        # @option opts [String] type Query type
+        # @option opts [Array] includedTerms Included terms of terms query
+        # @option opts [Array] contextTerms Content terms of the query
+        # @option opts [Array] excludedTerms Excluded terms of thequery
+        # @option opts [Array] languages Query languages
+        # @option opts [String] twitterScreenName Tracked twitter screen name
+        # @option opts [String] industry Industry of the query
+        # @option opts [Date] creationDate Date the query was created on
+        # @option opts [Date] lastModificationDate Modification date of the query
+        # @return [Hashie::Mash] New query
+        def create_query id, opts={}
+          post "projects/#{id}/queries", opts
+        end
+
+        # Update an existing query in project
+        #
+        # @param project_id [Integer] Id of project
+        # @param query_id [Integer] Id of query
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] id Id of the query
+        # @option opts [String] name Name of the project
+        # @option opts [Integer] dailyLimit Daily limit of the query
+        # @option opts [Integer] twitterLimit Twitter limit of the query
+        # @option opts [Integer] averageMonthlyMentions Average monthly mentions
+        # @option opts [String] type Query type
+        # @option opts [Array] includedTerms Included terms of terms query
+        # @option opts [Array] contextTerms Content terms of the query
+        # @option opts [Array] excludedTerms Excluded terms of thequery
+        # @option opts [Array] languages Query languages
+        # @option opts [String] twitterScreenName Tracked twitter screen name
+        # @option opts [String] industry Industry of the query
+        # @option opts [Date] creationDate Date the query was created on
+        # @option opts [Date] lastModificationDate Modification date of the query
+        # @return [Hashie::Mash] Updated query
+        def update_query project_id, query_id, opts={}
+          put "projects/#{project_id}/queries/#{query_id}", opts
+        end
+
+        # Delete an existing query project
+        #
+        # @param project_id [Integer] Id of project
+        # @param query_id [Integer] Id of query
+        # @return [Hashie::Mash] Deleted query
+        def delete_query project_id, query_id
+          delete "projects/#{project_id}/queries/#{query_id}"
+        end
+
+        include BWAPI::Client::Projects::Queries::Backfill
+        include BWAPI::Client::Projects::Queries::DateRange
+        include BWAPI::Client::Projects::Queries::Mentions
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+module BWAPI
+  class Client
+    module Projects
+      module Queries
+        module Backfill
+
+          # Get all backfills for query
+          #
+          # @param project_id [Integer] Id of project
+          # @param query_id [Integer] Id of query
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Integer] page Page of results to retrieve
+          # @option opts [Integer] pageSize Results per page
+          # @return [Hashie::Mash] All backfills for query
+          def backfills project_id, query_id, opts={}
+            get "projects/#{project_id}/queries/#{query_id}/backfill"
+          end
+
+          # Get specific backfill for query
+          #
+          # @param project_id [Integer] Id of project
+          # @param query_id [Integer] Id of query
+          # @param backfill_id [Integer] Id of backfill
+          # @return [Hashie::Mash] Backfill for query
+          def get_backfill project_id, query_id, backfill_id
+            get "projects/#{project_id}/queries/#{query_id}/backfill/#{backfill_id}"
+          end
+          alias :backfill :get_backfill
+
+          # Create new backfill for query
+          #
+          # @param project_id [Integer] Id of project
+          # @param query_id [Integer] Id of query
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Integer] projectId Id of the project
+          # @option opts [Integer] queryId Id of the query
+          # @option opts [Integer] id Id of the backfill
+          # @option opts [Integer] mentionsFound Mentions found from the backfill
+          # @option opts [Date] maxDate Max date for the backfill
+          # @option opts [Date] minDate Min date for the backfill
+          # @option opts [String] status Status of backfill
+          # @option opts [Integer] queryId Query id of backfill
+          # @option opts [String] statusMessages Current status message of backfill
+          # @return [Hashie::Mash] New backfill for query
+          def create_backfill project_id, query_id, opts
+            post "projects/#{project_id}/queries/#{query_id}/backfill", opts
+          end
+
+          # Delete backfill for query
+          #
+          # @param project_id [Integer] Id of project
+          # @param query_id [Integer] Id of query
+          # @param backfill_id [Integer] Id of backfill
+          # @return [Hashie::Mash] Deleted backfill for query
+          def delete_backfill project_id, query_id, backfill_id
+            delete "projects/#{project_id}/queries/#{query_id}/backfill/#{backfill_id}"
+          end
+
+        end
+      end
+    end
+  end
+end