gliffy 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d08e7fc8875943cfbb8dc56185f6162cc3ea967b
-  data.tar.gz: df6d8c71405d5fc7ad14523bda869bd45ed20f5e
+  metadata.gz: f6949d3523318bb17a56dae26086d4d8035c8845
+  data.tar.gz: 5de50165043f8ca7e8dc97a03132463851be7572
 SHA512:
-  metadata.gz: 2ca1cd73e086d17d17638300d2440d64c88b30035be88da258e803adcabaf084cf2c26d83bf51189ee3b85ee2f546256b714e8857babbe88003ee04ceab85f08
-  data.tar.gz: 6d204415352c176034d4c1a69ff7e5db4fef0b51a05058355d4919c95e46b9c69afd270fe95d423fac776ef97e3c23a1ec7726dcd145295941261c5e63400b86
+  metadata.gz: 7f10b34b25b22def22fcb9e5b994dc316e312e59605e06216aeb1e8bff552a2f4723feaae839ed43a42a4b1dfd50d7d133616dc5bf43c6b62f13c37bb278371f
+  data.tar.gz: ae784af337dde2e08a02f10e3cea1dd32cb847e3ae3f3edee2ad05b112c1994a53603fb3bba7c27e601d60cbfcfce984f8fffff2867c7f0c913e21888ed79d30

data/README.md

@@ -3,6 +3,7 @@ Gliffy API wrapper
 
 [![Gem Version](https://badge.fury.io/rb/gliffy.png)](http://badge.fury.io/rb/gliffy)
 [![Code Climate](https://codeclimate.com/github/bkon/gliffy.png)](https://codeclimate.com/github/bkon/gliffy)
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/bkon/gliffy/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
 
 Basic usage
 -----------
@@ -69,3 +70,65 @@ Basic usage
     user.admin = true
 
     user.accessible_folders
+
+Command-line client
+-------------------
+
+### Authenticating yourself to gliffy API
+
+CLI client looks for credentials in `~/.gliffy-cli` file by default. It is
+a YAML file with a following simple structure:
+
+    gliffy:
+      account: <YOUR ACCOUNT ID>
+      oauth:
+        consumer_key: <YOUR OAUTH CONSUMER KEY>
+        consumer_secret: <YOUR OAUTH CONSUMER SECRET>
+
+An alternative ways to specify API credentials are:
+* use `--credentials` flag
+```
+gliffy-cli --credentials <PATH TO CREDENTIALS FILE> ...
+```
+* use `--account-id`, `--consumer-key` and `--consumer-secret` flags
+```
+gliffy-cli --account-id <ID> --consumer-key <KEY> --consumer-secret <SECRET> ...
+```
+
+The next step is to impersonate an user:
+
+```
+gliffy-cli ... --user <USERNAME> ...
+```
+
+Keep in mind that new users are provisioned automatically, so if
+`<USERNAME>` does not exists, it will be created for you by Gliffy.
+
+### List of available commands:
+
+* `user add <USERNAME>`
+* `user delete <USERNAME>`
+* `user list`
+* `user update email <USERNAME>`
+* `user update password <USERNAME>`
+* `user admin grant <USERNAME>`
+* `user admin revoke <USERNAME>`
+* `document add`
+* `document content <ID>.<FORMAT>`
+* `document name <ID>.<FORMAT>`
+* `document delete <ID>`
+* `document rename <ID> <NAME>`
+* `document access public <ID>`
+* `document access private <ID>`
+* `folder documents <PATH>`
+* `folder folders <PATH>`
+* `folder users <PATH>`
+* `folder access grant <PATH> <USERNAME>`
+* `folder access revoke <PATH> <USERNAME>`
+* `folder document create <PATH> <DOCUMENT>`
+* `folder create <PATH>`
+* `folder delete <PATH>`
+
+### Misc functionality
+
+* `--log-http` enables HTTP requests and response logging to STDERR

data/bin/gliffy-cli

@@ -0,0 +1,50 @@
+#!ruby
+
+require 'gliffy'
+require 'gliffy/cli'
+require 'gli'
+require 'yaml'
+require 'http_logger'
+require 'logger'
+require 'pp'
+
+include GLI::App
+
+program_desc "Gliffy API Client"
+version "0.0.9"
+
+subcommand_option_handling :normal
+
+desc "Location of the credentials file (YAML)"
+arg_name "FILENAME"
+default_value File.join(Dir.home, ".gliffy-cli")
+flag [:credentials]
+
+desc "Account ID"
+arg_name "ID"
+flag ["account-id"]
+
+desc "Gliffy API consumer key"
+arg_name "KEY"
+flag ["consumer-key"]
+
+desc "Gliffy API consumer secret"
+arg_name "SECRET"
+flag ["consumer-secret"]
+
+desc "User to impersonate"
+arg_name "NAME"
+flag [:user]
+
+desc "Enable HTTP logging"
+switch "log-http"
+
+command :user do |c|
+  c.command :list do |sub|
+    sub.action do |global_options, options, args|
+      Gliffy::CLI::Task::User::List.new(global_options, options, args).run
+    end
+  end
+end
+
+exit run(ARGV)

data/lib/gliffy/api.rb

@@ -39,8 +39,8 @@ module Gliffy
 
     def web(url, params)
       consumer.create_signed_request(
-        :get, 
-        url + '?' + query(params), 
+        :get,
+        url + '?' + query(params),
         token
       ).path
     end
@@ -58,7 +58,7 @@ module Gliffy
         :action => 'create',
         :description => application_name
       )
-      
+
       token.token = response.string('//g:oauth-token')
       token.secret = response.string('//g:oauth-token-secret')
     end

data/lib/gliffy/api/facade.rb

@@ -59,17 +59,18 @@ module Gliffy
       end
 
       def grant_access_to_folder(username, path)
-        post("/accounts/#{account_id}/folders/#{escape_path path}/users/#{username}.xml",
-             :action => "update",
-             :read => "true",
-             :write => "true")
+        update_access_to_folder(username, path, "true")
       end
 
       def revoke_access_to_folder(username, path)
+        update_access_to_folder(username, path, "false")
+      end
+
+      def update_access_to_folder(username, path, value)
         post("/accounts/#{account_id}/folders/#{escape_path path}/users/#{username}.xml",
              :action => "update",
-             :read => "false",
-             :write => "false")
+             :read => value,
+             :write => value)
       end
 
       def get_users(account_id)

data/lib/gliffy/cli.rb

@@ -0,0 +1,6 @@
+module Gliffy::CLI
+end
+
+require 'gliffy/cli/task'
+require 'gliffy/cli/task/user'
+require 'gliffy/cli/task/user/list'

data/lib/gliffy/cli/task.rb

@@ -0,0 +1,59 @@
+require 'http_logger'
+require 'logger'
+
+module Gliffy
+  class CLI::Task
+    def initialize(options)
+      if options["log-http"]
+        enable_http_logging
+      end
+
+      @options = options
+    end
+
+    def enable_http_logging
+      HttpLogger.logger = Logger.new(STDERR)
+      HttpLogger.colorize = true
+    end
+
+    def stdout
+      STDOUT
+    end
+
+    def account
+      @account ||= load_account(@options)
+    end
+
+    def load_account(options)
+      account_id, consumer_key, consumer_secret = load_credentials(options)
+      api = Gliffy::API.new(account_id,
+                            consumer_key,
+                            consumer_secret)
+
+      api.impersonate(options["user"])
+      api.account
+    end
+
+    def load_credentials(options)
+      if has_custom_credentials? options
+        account_id = options["account-id"]
+        consumer_key = options["consumer-key"]
+        consumer_secret = options["consumer-secret"]
+      else
+        credentials = YAML.load_file(options["credentials"])
+
+        account_id = credentials["gliffy"]["account"]
+        consumer_key = credentials["gliffy"]["oauth"]["consumer_key"]
+        consumer_secret = credentials["gliffy"]["oauth"]["consumer_secret"]
+      end
+
+      [account_id, consumer_key, consumer_secret]
+    end
+
+    def has_custom_credentials?(options)
+      ["account-id",
+       "consumer-key",
+       "consumer-secret"].all? { |k| not options[k].nil? }
+    end
+  end
+end

data/lib/gliffy/cli/task/user.rb

@@ -0,0 +1,2 @@
+class Gliffy::CLI::Task::User < Gliffy::CLI::Task
+end

data/lib/gliffy/cli/task/user/list.rb

@@ -0,0 +1,11 @@
+class Gliffy::CLI::Task::User::List < Gliffy::CLI::Task
+  def initialize(global_options, options, args)
+    super global_options
+  end
+
+  def run
+    account.users.each do |u|
+      stdout.puts "%20s %40s" % [u.username, u.email]
+    end
+  end
+end

data/spec/lib/gliffy/cli/task/user/list_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Gliffy::CLI::Task::User::List do
+  let(:user1) do
+    double(Gliffy::User,
+           :username => "username1",
+           :email => "email1@test.com")
+  end
+
+  let(:user2) do
+    double(Gliffy::User,
+           :username => "username2",
+           :email => "email2@test.com")
+  end
+
+  let(:account) do
+    double(Gliffy::Account)
+  end
+
+  let(:stdout) do
+    stdout = double(STDOUT)
+    stdout.stub(:puts)
+    stdout
+  end
+
+  subject do
+    Gliffy::CLI::Task::User::List
+      .any_instance
+      .stub(:account)
+      .and_return(account)
+
+    Gliffy::CLI::Task::User::List
+      .new({ "account-id" => "ID",
+             "consumer-key" => "KEY",
+             "consumer-secret" => "SECRET",
+             "user" => "USERNAME" },
+           {},
+           {})
+  end
+
+  before :each do
+    account.stub(:users).and_return([user1, user2])
+    subject.stub(:stdout).and_return(stdout)
+  end
+
+  it "loads a list of users" do
+    subject.run
+
+    expect(account).to have_received :users
+  end
+
+  it "displays users" do
+    subject.run
+
+    expect(stdout).to have_received(:puts)
+      .with(match(user1.username))
+
+    expect(stdout).to have_received(:puts)
+      .with(match(user1.email))
+
+    expect(stdout).to have_received(:puts)
+      .with(match(user2.username))
+
+    expect(stdout).to have_received(:puts)
+      .with(match(user2.email))
+  end
+end

data/spec/lib/gliffy/cli/task/user_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Gliffy::CLI::Task::User do
+end

data/spec/lib/gliffy/cli/task_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+require 'yaml'
+
+describe Gliffy::CLI::Task do
+  let(:account) do
+    double(Gliffy::Account)
+  end
+
+  let(:api) do
+    api = double(Gliffy::API, :account => account)
+    api.stub(:impersonate)
+    api
+  end
+
+  before :each do
+    Gliffy::API
+      .stub(:new)
+      .and_return(api)
+
+    Gliffy::CLI::Task.any_instance.stub(:load_account).and_call_original
+  end
+
+  context "when initialized" do
+    let(:options) do
+      { "log-http" => false }
+    end
+
+    subject {
+      Gliffy::CLI::Task.new(options)
+    }
+
+    it "loads account data" do
+      Gliffy::CLI::Task.any_instance.stub(:load_credentials)
+        .and_return("ID", "KEY", "SECRET")
+
+      subject.account
+      expect(subject).to have_received(:load_account).once
+    end
+
+    it "caches account data" do
+      Gliffy::CLI::Task.any_instance.stub(:load_credentials)
+
+      subject.account
+      subject.account
+      expect(subject).to have_received(:load_account).once
+    end
+
+    it "has a reference to the output stream" do
+      expect(subject).to respond_to :stdout
+      expect(subject.stdout).to be_instance_of IO
+    end
+
+    context "when user provided custom credentials" do
+      let(:options) do
+        {
+          "account-id" => "ID",
+          "consumer-key" => "KEY",
+          "consumer-secret" => "SECRET"
+        }
+      end
+
+      it "knows it" do
+        expect(subject.has_custom_credentials?(options)).to be_true
+      end
+
+      it "uses credentials from the command line" do
+        credentials = subject.load_credentials(options)
+
+        expect(credentials).to eq ["ID", "KEY", "SECRET"]
+      end
+    end
+
+    context "when user does not provide custom credentials" do
+      let(:credentials_file_name) { "test.yaml" }
+      let(:credentials_file_contents) do
+%Q{
+gliffy:
+  account: 222
+  oauth:
+    consumer_key: "KEY2"
+    consumer_secret: "SECRET2"
+}
+      end
+
+      let(:options) do
+        {
+          "account-id" => nil,
+          "consumer-key" => nil,
+          "consumer-secret" => nil,
+          "credentials" => credentials_file_name
+        }
+      end
+
+      it "knows it" do
+        expect(subject.has_custom_credentials?(options)).to be_false
+      end
+
+      it "loads credentials from the credentials file" do
+        YAML.stub(:load_file).and_return(YAML.load(credentials_file_contents))
+
+        credentials = subject.load_credentials(options)
+
+        expect(credentials).to eq [222, "KEY2", "SECRET2"]
+        expect(YAML).to have_received(:load_file).with(credentials_file_name)
+      end
+    end
+  end
+
+  context "during the initialization" do
+    context "when log-http switch is on" do
+      let(:options) do
+        { "log-http" => true }
+      end
+
+      it "enables HTTP logging" do
+        HttpLogger.stub(:logger=)
+        subject = Gliffy::CLI::Task.new(options)
+        expect(HttpLogger).to have_received :logger=
+      end
+    end
+
+    context "when log-http switch is off" do
+      let(:options) do
+        { "log-http" => false }
+      end
+
+      it "does not enable HTTP logging" do
+        HttpLogger.stub(:logger=)
+        subject = Gliffy::CLI::Task.new(options)
+        expect(HttpLogger).to_not have_received :logger=
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -12,6 +12,7 @@ SimpleCov.start do
 end
 
 require 'gliffy'
+require 'gliffy/cli'
 Dir["./spec/support/**/*.rb"].sort.each {|f| require f}
 
 def fixture(filename, substitutions = {})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gliffy
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Konstantin Burnaev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-24 00:00:00.000000000 Z
+date: 2013-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -136,12 +150,28 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple Gliffy REST API wrapper.
 email: kbourn@gmail.com
-executables: []
+executables:
+- gliffy-cli
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/gliffy/cli.rb
 - lib/gliffy/folder.rb
 - lib/gliffy/document/presentation.rb
 - lib/gliffy/document/presentation/png.rb
@@ -153,6 +183,9 @@ files:
 - lib/gliffy/account.rb
 - lib/gliffy/api.rb
 - lib/gliffy/user.rb
+- lib/gliffy/cli/task.rb
+- lib/gliffy/cli/task/user/list.rb
+- lib/gliffy/cli/task/user.rb
 - lib/gliffy/document.rb
 - lib/gliffy/oauth/helper.rb
 - lib/gliffy.rb
@@ -177,12 +210,16 @@ files:
 - spec/lib/gliffy/api/response_spec.rb
 - spec/lib/gliffy/api/facade_spec.rb
 - spec/lib/gliffy/api/error_spec.rb
+- spec/lib/gliffy/cli/task_spec.rb
+- spec/lib/gliffy/cli/task/user_spec.rb
+- spec/lib/gliffy/cli/task/user/list_spec.rb
 - spec/lib/gliffy/document_spec.rb
 - spec/lib/gliffy/account_spec.rb
 - spec/lib/gliffy/folder_spec.rb
 - spec/lib/gliffy_spec.rb
 - README.md
 - LICENSE
+- bin/gliffy-cli
 homepage: https://github.com/bkon/gliffy
 licenses:
 - MIT
@@ -208,3 +245,4 @@ signing_key:
 specification_version: 4
 summary: Gliffy API client
 test_files: []
+has_rdoc: