opr 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1792360804ff4bb0d545126ae92164e26c250bb78eb9970a8f449ceea2f6c73
-  data.tar.gz: d22b82e1d53ce14e79fc7b650ad558faf0f604fce75f92627924faa8ec3252e7
+  metadata.gz: 60b9ea300b10f0bfe13e5b0920a77858e1368d6c5f03e3611867fc09e9d5d151
+  data.tar.gz: b2f3ade43eecbfab25e0bf21d2f21bbf99e7935b3f60a1ad3d1f10bc8ddd7d47
 SHA512:
-  metadata.gz: 70ec8ea6492598f4afa3ca5406a61f3fd677334452637b69d2aaf28361ab2315223f325888850fad0b6ebeadbe535635348f9d2a8fe30cf6ee093199e3ce62d5
-  data.tar.gz: cd1e34f9844125d3d17d2ab67e611293a916c10c972334789c7163387daaa5fd2bb3b6c5edec96fc95b422fe2953404ecc6d22c3d02b35740b1946fc6f0e18ab
+  metadata.gz: 59469077a64f27f07802049b2a1213b9ea32856230cd74a11c3d8673d60ef5c6ab920fb10d3af457ee28f169df52eab120bd792fe5492130304fc5df1da53cb4
+  data.tar.gz: ac4b903311d32d13afa1c14957e2ca0f19419dfddca70e61da4a9b55552ac0c2ccb120b1a94832159f8e59ef9e8deac7905765f000893db1bcb6984fe9d45a02

data/README.adoc

@@ -1,15 +1,14 @@
-# Rubyists::Opr
+# Opr
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubyists::opr`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem supplies the `opr` binary, which wraps the 1password `op` cli from https://1password.com/downloads/command-line/.
+The goal of opr is to be as compatible as possible with the `pass` cli from https://www.passwordstore.org/.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rubyists::opr'
+gem 'opr'
 ```
 
 And then execute:
@@ -18,11 +17,21 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install rubyists::opr
+    $ gem install opr
 
 ## Usage
 
-TODO: Write usage instructions here
+- `opr --help`
+- `opr list vaults` List all vaults
+- `opr list items --vault=SomeVault` List all items in SomeVault
+- `opr get SomeVault/SomeItem` Get the password from SomeVault named SomeItem. This should be piped to xclip/pbcopy.
+- `opr gen` Generate a new password (8-16 characters)
+- `echo "\#@%!" | opr gen` Generate a new password, using only "#@%!" as "special" characters.
+- `opr gen -s15` Generate a new password, 15 chars long
+- `opr gen -s15 NewItem` Generate a new password, 15 chars long, save as "NewItem" in vault "Private"
+- `opr gen -m15 -M20 NewItem --vault=MyVault` Generate a new password, 15-20 chars long, save as "NewItem" in vault "MyVault"
+- `opr rm NewItem --vault=MyVault` Remove the item 'NewItem' from vault 'MyVault'
+- `opr rm NewItem` Remove the item 'NewItem' from vault 'Private'
 
 ## Development
 
@@ -32,13 +41,13 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rubyists::opr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rubyists::opr/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/[rubyists]/opr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[rubyists]/opr/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## Code of Conduct
 
-Everyone interacting in the Rubyists::Opr project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rubyists::opr/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Rubyists::Opr project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[rubyists]/opr/blob/master/CODE_OF_CONDUCT.md).
 
 ## Copyright
 
-Copyright (c) 2019 Tj (bougyman) Vanderpoel. See [MIT License](LICENSE.txt) for further details.
+Copyright (c) 2019 Tj (bougyman) Vanderpoel. See [MIT License](LICENSE.txt) for further details.

data/lib/rubyists::opr/cli.rb

@@ -24,6 +24,20 @@ module Rubyists
       end
       map %w[--version -v] => :version
 
+      desc 'rm ITEM', 'Remove an item from a vault'
+      method_option :vault, aliases: '-v', type: :string,
+                             desc: 'The vault to look for ITEM'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      def rm(item)
+        if options[:help]
+          invoke :help, ['rm']
+        else
+          require_relative 'commands/rm'
+          Rubyists::Opr::Commands::Rm.new(item, options).execute
+        end
+      end
+
       desc 'get ITEM', 'Get the contents of an item'
       method_option :vault, aliases: '-v', type: :string, desc: 'Which vault the item is in'
       method_option :help, aliases: '-h', type: :boolean,

data/lib/rubyists::opr/commands/gen.rb

@@ -40,7 +40,8 @@ module Rubyists
           parsed = parse_path
           Opr.with_login do
             vault = Vault.find_by_name(parsed.vault)
-            vault.insert(name: parsed.name, type: :login, password: pass, username: options[:username])
+            vault.insert(title: parsed.name, type: :login, password: pass,
+                         username: options[:username], notes: options[:notes])
           end
           output.puts "#{parsed.name} saved in #{parsed.vault}"
         end

data/lib/rubyists::opr/commands/get.rb

@@ -23,7 +23,7 @@ module Rubyists
             warn 'No vault specified, using "Private"'
             vault = 'Private'
           end
-          Opr.with_login { output.puts Item.find(@item, vault: vault) }
+          Opr.with_login { output.puts Item.find(@item, vault: vault).password }
         end
       end
     end

data/lib/rubyists::opr/commands/rm.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+
+module Rubyists
+  module Opr
+    # Commands namespace
+    module Commands
+      # the rm command
+      class Rm < Rubyists::Opr::Command
+        def initialize(item, options)
+          @item = item
+          @options = options
+        end
+
+        def execute(input: $stdin, output: $stdout) # rubocop:disable Lint/UnusedMethodArgument
+          vault_name = if options[:vault]
+                         options[:vault]
+                       else
+                         warn 'No vault given, using "Private"'
+                         'Private'
+                       end
+          Opr.with_login do
+            found = Item.find(@item, vault: vault_name)
+            return(output.puts("No item '#{@item}' found in vault '#{vault_name}'")) if found.nil?
+
+            found.delete!
+            output.puts "Removed '#{@item}' from '#{vault_name}'"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubyists::opr/commands/templates/gen/login.erb

@@ -0,0 +1,19 @@
+{
+  "notesPlain": "<%= notes %>",
+  "sections": [],
+  "passwordHistory": [],
+  "fields": [
+    {
+      "value": "<%= username %>",
+      "name": "username",
+      "type": "T",
+      "designation": "username"
+    },
+    {
+      "value": "<%= password %>",
+      "name": "password",
+      "type": "P",
+      "designation": "password"
+    }
+  ]
+}

data/lib/rubyists::opr/model/item.rb

@@ -10,13 +10,26 @@ module Rubyists
         new uuid: hash['uuid'], name: hash['overview']['title'], raw: hash
       end
 
+      def self.create(hash, title, vault = 'Private', type: :login)
+        cmd = TTY::Command.new pty: true, printer: :null
+        
+        Opr.with_login do
+          cmd.run "#{Opr.opbin} create item '#{type.capitalize}' '#{hash}' --vault='#{vault}' --title='#{title}'"
+        end
+      end
+
       def self.find(item, vault:)
         cmd = TTY::Command.new pty: true, printer: :null
-        out, err = cmd.run "#{Opr.opbin} get item '#{item}' --vault='#{vault}'"
+        out, err = Opr.with_login do
+          cmd.run "#{Opr.opbin} get item '#{item}' --vault='#{vault}'"
+        end
         raise Error, err unless err.empty?
 
-        item = from_output out
-        item.password
+        from_output out
+      rescue TTY::Command::ExitError => e
+        return nil if e.to_s.match? /item with query "#{Regexp.escape(item)}" not found/
+
+        raise
       end
 
       attr_reader :name, :uuid, :raw
@@ -26,6 +39,17 @@ module Rubyists
         @raw  = raw
       end
 
+      def vault_uuid
+        @vault_uuid ||= raw['vaultUuid']
+      end
+
+      def delete!
+        Opr.with_login do
+          cmd = TTY::Command.new pty: true, printer: :null
+          cmd.run "#{Opr.opbin} delete item '#{name}' --vault='#{vault_uuid}'"
+        end
+      end
+
       def password
         pass_field = @raw['details']['fields'].detect { |f| f['designation'] == 'password' }
         pass_field['value']

data/lib/rubyists::opr/model/vault.rb

@@ -13,7 +13,9 @@ module Rubyists
 
       def self.all
         cmd = TTY::Command.new pty: true, printer: :null
-        out, err = cmd.run Opr.opbin, 'list', 'vaults'
+        out, err = Opr.with_login { cmd.run Opr.opbin, 'list', 'vaults' }
+        raise "Error #{err}" unless err.nil? || err.empty?
+
         vaults = JSON.parse out
         vaults.map { |v| from_hash v }
       end
@@ -28,21 +30,23 @@ module Rubyists
         @uuid = uuid
       end
 
-      def insert(name:, password:, type: 'login', username: nil, notes: nil)
-        current = Item.find(name, vault: self.name)
-        raise "There is already an item named #{name} in the #{self.name} vault" if current
+      def insert(title:, password:, type: 'login', username: nil, notes: nil)
+        current = Item.find(title, vault: name)
+        raise "There is already an item named #{title} in the #{name} vault" if current
 
         tpl = Opr::LIBDIR.join("commands/templates/gen/#{type}.erb")
         erb = ERB.new(tpl.read)
-        hash = JSON.parse erb.result(binding)
-        Item.create!(hash, vault: uuid, name: name)
+        json = erb.result(binding)
+        Item.create(json, title, name, type: :login)
       end
 
       def items
         return @items if @items
 
         cmd = TTY::Command.new pty: true, printer: :null
-        out, err = cmd.run "#{Opr.opbin} list items --vault='#{name}'"
+        out, err = Opr.with_login { cmd.run "#{Opr.opbin} list items --vault='#{name}'" }
+        raise "Error #{err}" unless err.nil? || err.empty?
+
         array = JSON.parse out
         @items = array.map { |h| Item.from_hash h }
       end

data/lib/rubyists::opr/templates/rm/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/rubyists::opr/version.rb

@@ -1,5 +1,5 @@
 module Rubyists
   module Opr
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opr
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tj (bougyman) Vanderpoel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-23 00:00:00.000000000 Z
+date: 2019-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -180,6 +180,8 @@ files:
 - lib/rubyists::opr/commands/list.rb
 - lib/rubyists::opr/commands/list/items.rb
 - lib/rubyists::opr/commands/list/vaults.rb
+- lib/rubyists::opr/commands/rm.rb
+- lib/rubyists::opr/commands/templates/gen/login.erb
 - lib/rubyists::opr/model/item.rb
 - lib/rubyists::opr/model/vault.rb
 - lib/rubyists::opr/templates/.gitkeep
@@ -188,6 +190,7 @@ files:
 - lib/rubyists::opr/templates/get/.gitkeep
 - lib/rubyists::opr/templates/list/items/.gitkeep
 - lib/rubyists::opr/templates/list/vaults/.gitkeep
+- lib/rubyists::opr/templates/rm/.gitkeep
 - lib/rubyists::opr/utils.rb
 - lib/rubyists::opr/version.rb
 - rubyists::opr.gemspec