bwcli 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74d73712b88433fc3573ed6361018686b95e8e18
+  data.tar.gz: 3705e7faae6ff8da83a0e92e85cc3dadfcc7293b
+SHA512:
+  metadata.gz: ba7a0d48b232ff53b3631fb9228b6a5ce5baf975459888ca21e44e1a1290f2b088a54fca2d8069a004eb84abfece61b783b1c3a4bf0104c6bc315f9bb91cc5ae
+  data.tar.gz: caefe5b3737721cb1819932fe56c213dd852c3290d77a026f20353dca64da1e135e077d1564e35beb0313b9c204ec09c70ebc58f847f7ed0a84e00e255b48699

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+
+Gemfile.lock
+report.html
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem 'bundler', '~> 1.3.5'
+gem "coveralls", "~> 0.6.7", require: false
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Jonathan Chrisp
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,7 @@
+# bwcli
+
+__PLEASE NOTE THAT THIS PROJECT IS NOT OFFICIALLY SUPPORTED BY BRANDWATCH__
+
+A command line interface to interact with the Brandwatch API
+
+

data/bin/bwcli

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'bwcli'
+BWCLI::BW.start ARGV

data/bwcli.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name        = 'bwcli'
+  s.version     = '1.0.0'
+  s.date        = '2013-08-15'
+  s.summary     = 'Brandwatch CLI'
+  s.description = 'A CLI interface to interact with the Brandwatch v2 API'
+  s.author      = 'Jonathan Chrisp'
+  s.email       = 'jonathan@brandwatch.com'
+  s.license     = 'MIT'
+  s.homepage    = 'https://github.com/jonathanchrisp/bwcli'
+  s.required_ruby_version = ">= 1.9.2"
+
+  s.add_development_dependency 'rspec', '~> 2.13.0'
+  s.add_development_dependency 'pry', '~> 0.9.12.2'
+
+  s.add_runtime_dependency 'bwapi', '~> 1.0.0'
+  s.add_runtime_dependency 'thor', '~> 0.18.1'
+  s.add_runtime_dependency 'awesome_print', '~> 1.1.0'
+  s.add_runtime_dependency 'hashie', '~> 2.0.5'
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+end

data/lib/bwcli/config.rb

@@ -0,0 +1,66 @@
+require 'bwcli/configuration'
+
+module BWCLI
+
+  # Config subcommand
+  class Config < Thor
+
+    no_tasks do
+      def configuration
+        @configuration ||= BWCLI::Configuration.new
+      end
+      alias :conf :configuration
+    end
+
+    desc "user", "Returns the current user"
+    def user
+      conf.list_current_user
+    end
+
+    desc "login", "Authenticate current user"
+    def login
+      conf.oauth
+    end
+
+    desc "list", "List users"
+    def list
+      conf.list_users
+    end
+
+    desc "add", "Add a new user"
+    method_option :e, :banner => 'Environment', :required => true
+    method_option :u, :banner => 'Username', :required => true
+    method_option :p, :banner => 'Password', :required => true
+    def add
+      conf.add_user options[:e], options[:u], options[:p]
+
+      # Set as current user if no current user exists
+      return conf.set_current_user options[:e], options[:u] unless conf.current_user_exists?
+
+      # If current user exists check to switch
+      conf.set_current_user options[:e], options[:u] if yes? "Would you like set this user as the current user?"
+    end
+
+    desc "switch", "Switch to user"
+    method_option :u, :banner => 'Username', :required => true
+    method_option :e, :banner => 'Environment', :required => true
+    def switch
+      conf.set_current_user options[:e], options[:u]
+    end
+
+    desc "remove", "Remove a new user"
+    method_option :u, :banner => 'Username', :required => true
+    method_option :e, :banner => 'Environment', :required => true
+    def remove
+      conf.remove_user options[:u], options[:e]
+    end
+
+    desc "reset", "Reset the conf file"
+    def reset
+      conf.reset if yes? "Are you sure you want to reset your config?"
+    end
+
+    include Thor::Actions
+
+  end
+end

data/lib/bwcli/configuration.rb

@@ -0,0 +1,186 @@
+require 'yaml'
+
+module BWCLI
+
+  # Configuration class to maintain config
+  class Configuration
+
+    # Initialises the configuration class
+    def initialize
+      @config_file = File.join(File.expand_path("~"), ".bwcli")
+      @config = Hashie::Mash.new(YAML.load_file @config_file)
+    rescue Errno::ENOENT
+      abort "You dont have a .bwcli file!".red.underline
+    end
+
+    # Add user to the config hash
+    #
+    # @param [String] env the environment
+    # @param [String] username the username of the user
+    # @param [String] pwd the password of the user
+    def add_user env, username, pwd
+      config[env] = {} unless env_exists? env
+      abort "The #{username} already exists!".yellow if user_exists? env, username
+      config[env][username] = { 'access_token' => '', 'password' => pwd }
+      write_config
+    end
+
+    # Returns the api endpoint for the current user
+    #
+    # @return [String] the api endpoint
+    def api_endpoint
+      case current_user.environment
+      when 'int', 'integration'
+        'http://newapi.int.brandwatch.com'
+      when 'rel', 'release', 'stage'
+        'http://newapi.rel.brandwatch.com'
+      else
+        'http://newapi.brandwatch.com'
+      end
+    end
+
+    # Creates and returns bwapi instance
+    #
+    # @return [Object] bwapi the bwapi instance
+    def bwapi
+      abort "You have no current user set!".yellow unless current_user_exists?
+      abort "There is no access token set for the current user".yellow if config.current_user.access_token.nil?
+      abort "There is no environment set for the current user".yellow if config.current_user.environment.nil?
+
+      return @bwapi ||= BWAPI::Client.new(:username => current_user.username, :password => current_user.password, :api_endpoint => api_endpoint)
+    end
+
+    # Returns the config
+    #
+    # @return [Hash] config the current config
+    def config
+      @config
+    end
+
+    # Returns the current user set in config hash
+    #
+    # @return [Hash] returns the current user
+    def current_user
+      abort "You have no current user set!".yellow unless current_user_exists?
+      config.current_user
+    end
+
+    # Check whether the current user exists in the config hash
+    #
+    # @return [Boolean]
+    def current_user_exists?
+      return false if config.current_user.nil?
+      return true
+    end
+
+    # Check whether a env exists in the config hash
+    #
+    # @param [String] env the environment
+    # @return [Boolean]
+    def env_exists? env
+      return false if config.nil?
+      config.has_key? env
+    end
+
+    # List all users within the config hash
+    def list_users
+      abort "You have no users within your config file!".yellow if config.empty?
+      puts "\nUser Configuration".yellow
+      config.each do |k, v|
+        next if k == 'current_user'
+        puts "\nEnvironment: #{k}".yellow
+        print_hash_values v
+      end
+
+      list_current_user if current_user_exists?
+    end
+
+    # List the current user within the config hash
+    def list_current_user
+      abort "You have no current user set!".yellow unless current_user_exists?
+      puts "\nCurrent User:".yellow
+      config.current_user.each do |k,v|
+        puts "#{k.yellow}: #{v}\n" unless v.nil?
+      end
+    end
+
+    # Authenticates current user
+    def oauth
+      if current_user.access_token.nil? || current_user.access_token.empty?
+        abort "Unable to login as #{current_user.username}".red unless bwapi.login
+        set_access_token bwapi.access_token
+      else
+        bwapi.access_token = current_user.access_token
+        abort "Unable to login as #{current_user.username}".red unless bwapi.login
+      end
+
+      return bwapi
+    end
+
+    # Print out hash values
+    def print_hash_values hash
+      puts hash.yellow unless hash.is_a? Hash
+      hash.each do |k, v|
+        if v.is_a? Hash
+          puts "User: #{k}:".yellow
+          print_hash_values v
+        else
+          puts " - #{k}: #{v}"
+        end
+      end
+    end
+
+    # Resets the config to an empty hash
+    def reset
+      @config = {}
+      write_config
+    end
+
+    # Set current user
+    #
+    # @param [String] env the environment
+    # @param [String] username the username of the user
+    def set_current_user env, username
+      abort "The #{username} doesn't exist! Please add!".yellow unless user_exists? env, username
+      config.current_user = { 'username' => username, 'environment' => env, 'password' => config[env][username].password, 'access_token' => config[env][username].access_token }
+      write_config
+    end
+
+    # Sets access token for current user
+    #
+    # @param [String] token the access token to store in  config hash
+    def set_access_token token
+      current_user.access_token = token
+      config[current_user.environment].access_token = token
+      write_config
+    end
+
+    # Remove user
+    #
+    # @param [String] username the username of the user
+    # @param [String] env the environment
+    def remove_user username, env
+      abort "You have no users within your config file!".yellow if config.empty?
+      abort "This user is currently set as the current user! Aborting!".yellow if current_user.username == username && current_user.env == env
+      abort "The #{username} doesn't exist!".yellow unless user_exists? env, username
+      config[env].delete username
+      write_config
+    end
+
+    # Check whether a user exists in the config hash
+    #
+    # @param [String] env the environment
+    # @param [String] username the username of the user
+    # @return [Boolean]
+    def user_exists? env, username
+      return false  if config.nil? || config.empty?
+      return true   if config[env].has_key? username
+    end
+
+    # Writes the config to file
+    def write_config
+      File.open(@config_file, "w"){|f| YAML.dump(config, f)}
+    end
+
+  end
+end

data/lib/bwcli/me.rb

@@ -0,0 +1,21 @@
+require 'bwcli/configuration'
+
+module BWCLI
+
+  # Me subcommand
+  class Me < Thor
+
+    no_tasks do
+      def configuration
+        @configuration ||= BWCLI::Configuration.new
+      end
+    end
+
+    desc "me", "Users credentials"
+    def me
+      ap configuration.oauth.me
+    end
+    default_task :me
+
+  end
+end

data/lib/bwcli/projects.rb

@@ -0,0 +1,26 @@
+require 'bwcli/configuration'
+
+module BWCLI
+
+  # Projects subcommand
+  class Projects < Thor
+
+    no_tasks do
+      def configuration
+        @configuration ||= BWCLI::Configuration.new
+      end
+    end
+
+    desc "projects", "Users projects"
+    method_option :i, :banner => 'project id', :required => false
+    def projects
+      if options[:i].nil?
+        ap configuration.oauth.projects
+      else
+        configuration.oauth.project options[:i]
+      end
+    end
+    default_task :projects
+
+  end
+end

data/lib/bwcli.rb

@@ -0,0 +1,33 @@
+require 'thor'
+require 'hashie'
+require 'awesome_print'
+require 'bwapi'
+require 'bwcli/configuration'
+require 'bwcli/config'
+require 'bwcli/me'
+require 'bwcli/projects'
+
+module BWCLI
+
+  # BWCLI command
+  class BW < Thor
+
+    no_tasks do
+      def configuration
+        @configuration ||= BWCLI::Configuration.new
+      end
+    end
+
+    desc "config", "User configuration"
+    subcommand "config", Config
+
+    desc "me", "Me endpoint"
+    subcommand "me", Me
+
+    desc "projects", "Project endpoints"
+    subcommand "projects", Projects
+
+    include Thor::Actions
+
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: bwcli
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan Chrisp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.2
+- !ruby/object:Gem::Dependency
+  name: bwapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+description: A CLI interface to interact with the Brandwatch v2 API
+email: jonathan@brandwatch.com
+executables:
+- bwcli
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- bin/bwcli
+- bwcli.gemspec
+- lib/bwcli.rb
+- lib/bwcli/.DS_Store
+- lib/bwcli/config.rb
+- lib/bwcli/configuration.rb
+- lib/bwcli/me.rb
+- lib/bwcli/projects.rb
+homepage: https://github.com/jonathanchrisp/bwcli
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: Brandwatch CLI
+test_files: []
+has_rdoc: