lastpass-api 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2425a8ba66083cd5a82dcf4c1f6ac2181370bbaf
+  data.tar.gz: ca05d47f5115de2bc195c2e57f969f89cb568d80
+SHA512:
+  metadata.gz: bcff24dd438a9b02075e44ecbf558dd81a4c4e1dfe25aaffa0d0a57a8ef785d1745c3f76f59ce658af9d2ddaaa9440ed3ff1ba10557d5e018bb590214ec6bc87
+  data.tar.gz: b893abc29437a51ded0ed07a65d812da6a82c83db57acf7142c81f5325b057ef69cedd87dcb30f75acc0e07bcca6e915b4ae15295af89d00ce62f1c820677434

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at eric@entretechno.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lastpass.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Entrepreneurial Technologies
+
+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,229 @@
+# Lastpass API
+
+[![Gem Version](https://badge.fury.io/rb/lastpass-api.svg)](https://badge.fury.io/rb/lastpass-api)
+![](http://ruby-gem-downloads-badge.herokuapp.com/lastpass-api?type=total)
+[![Inline docs](http://inch-ci.org/github/entretechno/lastpass-api.svg?branch=master)](http://inch-ci.org/github/entretechno/lastpass-api)
+
+Read/Write access to the online [LastPass](https://www.lastpass.com) vault using LastPass CLI to create, read, and update account information and credentials.
+
+## Installation
+
+```bash
+gem install lastpass-api
+```
+
+This gem depends on [lpass](https://github.com/lastpass/lastpass-cli), which requires the `lpass` executable to be installed and in the PATH. Try running one of these (depending on your OS) to install `lpass`:
+
+```bash
+# Ubuntu (may have to build manually to install verion v1)
+sudo apt-get install openssl libcurl4-openssl-dev libxml2 libssl-dev libxml2-dev pinentry-curses xclip cmake
+sudo apt-get install lastpass-cli
+
+# Homebrew (OS X)
+brew update && brew install lastpass-cli
+
+# MacPorts (OS X)
+sudo port selfupdate && sudo port install lastpass-cli
+
+# Debian (may have to build manually to install verion v1)
+sudo apt-get install openssl libcurl3 libxml2 libssl-dev libxml2-dev libcurl4-openssl-dev pinentry-curses xclip
+sudo apt-get install lastpass-cli
+
+# Fedora
+sudo dnf install lastpass-cli
+
+# Redhat/Centos
+sudo yum install openssl libcurl libxml2 pinentry xclip openssl-devel libxml2-devel libcurl-devel
+sudo yum install lastpass-cli
+
+# Gentoo
+sudo emerge lastpass-cli
+
+# FreeBSD
+sudo pkg install security/lastpass-cli
+sudo make -C /usr/ports/security/lastpass-cli all install clean
+
+# Cygwin
+apt-cyg install wget make cmake gcc-core gcc-g++ openssl-devel libcurl-devel libxml2-devel libiconv-devel cygutils-extra
+```
+
+Instructions for building manually:  https://github.com/lastpass/lastpass-cli#building
+
+## Usage
+
+```ruby
+require 'lastpass-api'
+@lastpass = Lastpass::Client.new
+```
+
+### Login
+
+```ruby
+@lastpass.login( email: 'user@example.com', password: 'secret' )
+puts @lastpass.logged_in?
+```
+
+### Accounts
+
+#### Create account credentials
+
+```ruby
+# Create an optional group to place account into
+@lastpass.groups.create( name: 'MyGroup' )
+
+# Create account
+account = @lastpass.accounts.create(
+  name: 'MyAccount',
+  username: 'root',
+  password: 'pass',
+  url: 'http://www.example.com',
+  notes: 'This is my note.',
+  group: 'MyGroup'
+)
+puts account.id
+```
+
+#### Find and read credentials
+
+```ruby
+# Find a specific account by name
+account = @lastpass.accounts.find( 'MyAccount', with_password: true )
+
+# Find a specific account by ID
+account = @lastpass.accounts.find( 1234, with_password: true )
+
+puts account.to_h
+# => { id: '1234', name: 'MyAccount', username: 'root', password: 'pass', url: 'http://www.example.com', notes: 'This is my note.', group: 'MyGroup' }
+
+# Find all accounts that match string (or regex)
+accounts = @lastpass.accounts.find_all( 'MyAcc' )
+puts accounts.count
+puts accounts.first.to_h
+
+# Fetch all accounts - same as find_all( '.*' )
+@lastpass.accounts.find_all
+```
+
+#### Update account
+
+```ruby
+# Update using instance variables
+account = @lastpass.accounts.find( 'MyAccount' )
+account.name = 'MyAccount EDIT'
+account.username = 'root EDIT'
+account.password = 'pass EDIT'
+account.url = 'http://www.exampleEDIT.com'
+account.notes = 'This is my notes. EDIT'
+account.save
+
+# Update using the update method
+account = @lastpass.accounts.find( 'MyAccount' )
+account.update(
+  name: 'MyAccount EDIT',
+  username: 'root EDIT',
+  password: 'pass EDIT',
+  url: 'http://www.exampleEDIT.com',
+  notes: 'This is my note. EDIT'
+)
+```
+
+#### Delete account
+
+```ruby
+account = @lastpass.accounts.find( 1234 )
+account.delete
+```
+
+### Groups (Folders)
+
+#### Create group
+
+```ruby
+group = @lastpass.groups.create( name: 'Group1' )
+puts group.id
+```
+
+#### Find group
+
+```ruby
+# Find a specific group by name
+group = @lastpass.groups.find( 'Group1' )
+
+# Find a specific group by ID
+group = @lastpass.groups.find( 1234 )
+
+puts group.to_h
+# => { id: '1234', name: 'Group1' }
+
+# Find all groups that match string (or regex)
+groups = @lastpass.groups.find_all( 'Gro' )
+puts groups.count
+puts groups.first.to_h
+
+# Fetch all groups - same as find_all( '.*' )
+@lastpass.groups.find_all
+```
+
+#### Update group (rename a group)
+
+```ruby
+# Update using instance variables
+group = @lastpass.groups.find( 'Group1' )
+group.name = 'Group1 EDIT'
+group.save
+
+# Update using the update method
+group = @lastpass.groups.find( 'Group1' )
+group.update( name: 'Group1 EDIT' )
+```
+
+#### Delete group
+
+```ruby
+group = @lastpass.groups.find( 1234 )
+group.delete
+```
+
+### Logout
+
+```ruby
+@lastpass.logout
+puts @lastpass.logged_out?
+```
+
+### Verbose
+
+Turning on verbose will show much more output.  This is good for debugging.  It will output any commands that are executed with `lpass`.
+
+```ruby
+@lastpass = Lastpass::Client.new( verbose: true )
+# or
+Lastpass.verbose = true
+```
+
+### Directly interacting with CLI
+
+```ruby
+Lastpass::Cli.login( username, password:, trust: false, plaintext_key: false, force: false )
+Lastpass::Cli.logout( force: false )
+Lastpass::Cli.show( account, clip: false, expand_multi: false, all: false, basic_regexp: false, id: false )
+Lastpass::Cli.ls( group = nil, long: false, m: false, u: false )
+Lastpass::Cli.add( name, username: nil, password: nil, url: nil, notes: nil, group: nil )
+Lastpass::Cli.add_group( name )
+Lastpass::Cli.edit( id, name: nil, username: nil, password: nil, url: nil, notes: nil, group: nil )
+Lastpass::Cli.edit_group( id, name: )
+Lastpass::Cli.rm( id )
+Lastpass::Cli.status( quiet: false )
+Lastpass::Cli.sync
+Lastpass::Cli.export
+Lastpass::Cli.import( csv_filename )
+Lastpass::Cli.version
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/entretechno/lastpass-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new( :spec )
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'lastpass-api'
+
+require 'irb'
+IRB.start

data/lastpass-api.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path( '../lib', __FILE__ )
+$LOAD_PATH.unshift( lib ) unless $LOAD_PATH.include?( lib )
+require 'lastpass-api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lastpass-api'
+  spec.version       = Lastpass::VERSION
+  spec.authors       = ['Eric Terry']
+  spec.email         = ['eterry1388@aol.com']
+
+  spec.summary       = 'Read/Write access to the online LastPass vault using LastPass CLI'
+  spec.description   = 'Full access to the LastPass vault to create, read, and update account information and credentials.'
+  spec.homepage      = 'http://www.entretechno.com'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split( "\x0" ).reject do |file|
+    file.match( %r{^(test|spec|features)/} )
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep( %r{^exe/} ) { |file| File.basename( file ) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'colorize'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake',    '~> 10.0'
+  spec.add_development_dependency 'rspec',   '~> 3.0'
+  spec.add_development_dependency 'byebug'
+end

data/lib/lastpass-api.rb

@@ -0,0 +1,42 @@
+require 'lastpass-api/utils'
+require 'lastpass-api/collection'
+require 'lastpass-api/cli'
+require 'lastpass-api/client'
+require 'lastpass-api/account'
+require 'lastpass-api/accounts'
+require 'lastpass-api/group'
+require 'lastpass-api/groups'
+require 'lastpass-api/parser'
+
+# Read/Write API client for LastPass using the LastPass CLI. I am not
+# affiliated with LastPass.
+#
+# @author {mailto:eterry1388@aol.com Eric Terry}
+# @note Tested with LastPass CLI v1.1.2
+# @note This gem currently can only login with one account at a time!
+module Lastpass
+  @@verbose = false
+
+  def self.verbose
+    @@verbose
+  end
+
+  def self.verbose=( verbose )
+    @@verbose = verbose
+  end
+
+  def self.check_lpass_in_path
+    error_message = 'Cannot find the "lpass" executable in the path!'
+    begin
+      raise error_message if Utils.cmd( 'which lpass' ) == ''
+    rescue
+      raise error_message
+    end
+    version = Utils.cmd( 'lpass --version' )
+    unless version.include? 'v1.'
+      raise "The LastPass CLI you have installed [#{version&.chomp}] is not supported. Please install LastPass CLI v1"
+    end
+  end
+
+  check_lpass_in_path # Check upon requiring the gem
+end

data/lib/lastpass-api/account.rb

@@ -0,0 +1,108 @@
+module Lastpass
+  class Account
+    attr_reader :id, :group # TODO: Make group editable eventually
+    attr_accessor :name, :username, :password, :url, :notes
+
+    def initialize( params )
+      params_to_account( params )
+    end
+
+    def update( params )
+      deleted! if @deleted
+      params.delete( :id ) # Prevent overwriting ID
+      params.delete( :group ) # Prevent overwriting group
+      params_to_account( params )
+      save
+    end
+
+    # TODO: This does not support changing groups yet!
+    def save
+      deleted! if @deleted
+      # If there is an ID, update that entry
+      if @id
+        Cli.edit( @id,
+          name:     @name,
+          username: @username,
+          password: @password,
+          url:      @url,
+          notes:    @notes,
+          group:    @group
+        )
+      else # If no ID, that means this is a new entry
+        Cli.add( @name,
+          username: @username,
+          password: @password,
+          url:      @url,
+          notes:    @notes,
+          group:    @group
+        )
+        set_id_after_save
+      end
+      self
+    end
+
+    def delete
+      Cli.rm( @id )
+      @deleted = true
+    end
+
+    def to_hash
+      params = {}
+      params[:id]       = @id       if @id
+      params[:name]     = @name     if @name
+      params[:username] = @username if @username
+      params[:password] = @password if @password
+      params[:url]      = @url      if @url
+      params[:notes]    = @notes    if @notes
+      params[:group]    = @group    if @group
+      params
+    end
+
+    alias_method :to_h, :to_hash
+
+    # Hide instance variables and values
+    def inspect
+      original_inspect = super
+      original_inspect.split( ' ' ).first << '>'
+    end
+
+    private
+
+    def params_to_account( params )
+      set_group_and_name( params[:name] ) # Infer group from the name
+      @group    = params[:group]    if params[:group] # Overwrite group if explicitly set
+      @id       = params[:id]       if params[:id]
+      @username = params[:username] if params[:username]
+      @password = params[:password] if params[:password]
+      @url      = params[:url]      if params[:url]
+      @notes    = params[:notes]    if params[:notes]
+    end
+
+    def set_group_and_name( string )
+      if string
+        split_name = string.split( '/' )
+        if split_name.count == 1
+          @name = split_name.first
+        else
+          @name = split_name.last
+          @group = split_name.first
+        end
+      end
+    end
+
+    def set_id_after_save
+      show_name = ''
+      show_name << "#{@group}/" if @group
+      show_name << @name
+      response = Cli.show( show_name, id: true )
+      if response.nil? || response == '' || response.include?( 'Multiple matches found' )
+        raise "Unable to fetch ID of newly created account! Name may have not been unique. Response: #{response}"
+      end
+      @id = response
+    end
+
+    def deleted!
+      raise "Account [ID:#{@id}] has been deleted!"
+    end
+  end
+end

data/lib/lastpass-api/accounts.rb

@@ -0,0 +1,29 @@
+module Lastpass
+  class Accounts < Collection
+
+    def find( search_text, with_password: false )
+      params = super
+      if params.is_a?( Hash ) && !params[:name]&.end_with?( '/' )
+        Account.new( params )
+      end
+    end
+
+    def find_all( search_text = '.*', with_passwords: false )
+      accounts = super.select { |params| !params[:name]&.end_with? '/' }
+      accounts.map do |params|
+        Account.new( params )
+      end
+    end
+
+    def create( params )
+      params.delete( :id ) # Prevent overwriting ID
+      Account.new( params ).save
+    end
+
+    # Hide instance variables and values
+    def inspect
+      original_inspect = super
+      original_inspect.split( ' ' ).first << '>'
+    end
+  end
+end

data/lib/lastpass-api/cli.rb

@@ -0,0 +1,209 @@
+require 'timeout'
+
+module Lastpass
+
+  # Low-level interaction with LastPass CLI
+  class Cli
+    UPLOAD_QUEUE_PATH = '~/.lpass/upload-queue' # TODO: Make this configurable? Or at least smarter?
+
+    # Login to LastPass, opening up a global session
+    #
+    # @note lpass login [--trust] [--plaintext-key [--force, -f]] [--color=auto|never|always] USERNAME
+    def self.login( username, password:, trust: false, plaintext_key: false, force: false )
+      command = "echo '#{password}' | LPASS_DISABLE_PINENTRY=1 lpass login"
+      command << ' --trust' if trust
+      command << ' --plaintext-key' if plaintext_key
+      command << ' --force' if force
+      command << " '#{escape( username )}'"
+      Utils.cmd command
+    end
+
+    # @note lpass logout [--force, -f] [--color=auto|never|always]
+    def self.logout( force: false )
+      command = 'echo "Y" | lpass logout'
+      command << ' --force' if force
+      Utils.cmd command
+    end
+
+    # @note lpass passwd
+    def self.passwd
+      not_implemented!
+    end
+
+    # @note lpass show [--sync=auto|now|no] [--clip, -c] [--expand-multi, -x] [--all|--username|--password|--url|--notes|--field=FIELD|--id|--name|--attach=ATTACHID] [--basic-regexp, -G|--fixed-strings, -F] [--color=auto|never|always] {UNIQUENAME|UNIQUEID}
+    def self.show( account, clip: false, expand_multi: false, all: false, basic_regexp: false, id: false )
+      sync # Ensure everything is synced up before running!
+      command = 'lpass show'
+      command << ' --clip' if clip
+      command << ' --expand-multi' if expand_multi
+      command << ' --all' if all
+      command << ' --basic-regexp' if basic_regexp
+      command << ' --id' if id
+      command << " '#{escape( account )}'"
+      response = Utils.cmd command
+      # Don't let LastPass know the accounts were accessed as it clogs up the sync!
+      # So clear out sync files if a lot of accounts were accessed at the same time.
+      remove_sync_files if response.length > 400
+      response
+    end
+
+    # @note lpass ls [--sync=auto|now|no] [--long, -l] [-m] [-u] [--color=auto|never|always] [GROUP]
+    def self.ls( group = nil, long: false, m: false, u: false )
+      sync # Ensure everything is synced up before running!
+      command = 'lpass ls'
+      command << ' --long' if long
+      command << ' -m' if m
+      command << ' -u' if u
+      command << " '#{escape( group )}'" if group
+      response = Utils.cmd command
+      # Don't let LastPass know the accounts were accessed as it clogs up the sync!
+      # So clear out sync files if a lot of accounts were accessed at the same time.
+      remove_sync_files if response.length > 400
+      response
+    end
+
+    # @note lpass mv [--color=auto|never|always] {UNIQUENAME|UNIQUEID} GROUP
+    def self.mv
+      not_implemented!
+    end
+
+    # @note lpass add [--sync=auto|now|no] [--non-interactive] [--color=auto|never|always] {--username|--password|--url|--notes|--field=FIELD|--note-type=NOTETYPE} NAME
+    def self.add( name, username: nil, password: nil, url: nil, notes: nil, group: nil )
+      data = {}
+      data[:Username] = escape( username,   double: true ) if username
+      data[:Password] = escape( password,   double: true ) if password
+      data[:URL]      = escape( url,        double: true ) if url
+      data[:Notes] = '\n' << escape( notes, double: true ) if notes
+
+      command = 'printf "'
+      command << data.map { |d| d.join( ': ' ) }.join( '\n' )
+      command << '" | lpass add --non-interactive --sync=no \''
+      command << "#{escape( group )}/" if group
+      command << "#{escape( name )}'"
+      response = Utils.cmd command
+      sync
+      response
+    end
+
+    # @note lpass add [--sync=auto|now|no] [--non-interactive] [--color=auto|never|always] {--username|--password|--url|--notes|--field=FIELD|--note-type=NOTETYPE} NAME
+    def self.add_group( name )
+      response = Utils.cmd "printf 'URL: http://group' | lpass add --non-interactive --sync=no '#{escape( name )}/'"
+      sync
+      response
+    end
+
+    # @note lpass edit [--sync=auto|now|no] [--non-interactive] [--color=auto|never|always] {--name|--username|--password|--url|--notes|--field=FIELD} {NAME|UNIQUEID}
+    def self.edit( id, name: nil, username: nil, password: nil, url: nil, notes: nil, group: nil )
+      data = {}
+      name_with_group = ''
+      name_with_group << "#{group}/" if group
+      name_with_group << name if name
+
+      data[:Name]     = escape( name_with_group, double: true ) unless name_with_group == ''
+      data[:Username] = escape( username,        double: true ) if username
+      data[:Password] = escape( password,        double: true ) if password
+      data[:URL]      = escape( url,             double: true ) if url
+      data[:Notes] = '\n' << escape( notes,      double: true ) if notes
+
+      command = 'printf "'
+      command << data.map { |d| d.join( ': ' ) }.join( '\n' )
+      command << '" | lpass edit --non-interactive --sync=no '
+      command << id
+      response = Utils.cmd command
+      sync
+      response
+    end
+
+    # @note lpass edit [--sync=auto|now|no] [--non-interactive] [--color=auto|never|always] {--name|--username|--password|--url|--notes|--field=FIELD} {NAME|UNIQUEID}
+    def self.edit_group( id, name: )
+      command = 'printf "'
+      command << "Name: #{escape( name, double: true )}/"
+      command << '" | lpass edit --non-interactive --sync=no '
+      command << id
+      response = Utils.cmd command
+      sync
+      response
+    end
+
+    # @note lpass generate [--sync=auto|now|no] [--clip, -c] [--username=USERNAME] [--url=URL] [--no-symbols] {NAME|UNIQUEID} LENGTH
+    def self.generate
+      not_implemented! # TODO
+    end
+
+    # @note lpass duplicate [--sync=auto|now|no] [--color=auto|never|always] {UNIQUENAME|UNIQUEID}
+    def self.duplicate
+      not_implemented!
+    end
+
+    # @note lpass rm [--sync=auto|now|no] [--color=auto|never|always] {UNIQUENAME|UNIQUEID}
+    def self.rm( id )
+      response = Utils.cmd "lpass rm --sync=no #{id}"
+      sync
+      response
+    end
+
+    # @note lpass status [--quiet, -q] [--color=auto|never|always]
+    def self.status( quiet: false )
+      command = 'lpass status'
+      command << ' --quiet' if quiet
+      Utils.cmd command
+    end
+
+    # @note This is a buggy function of the lpass executable. May not be super reliable.
+    # @note lpass sync [--background, -b] [--color=auto|never|always]
+    def self.sync
+      sleep 1 # Allow file IO before attempting sync
+      Utils.cmd 'lpass sync'
+      sleep 1 # Allow sync to finish
+    end
+
+    # @note lpass export [--sync=auto|now|no] [--color=auto|never|always]
+    def self.export
+      Utils.cmd 'lpass export'
+    end
+
+    # @note lpass import [CSV_FILENAME]
+    def self.import( csv_filename )
+      Utils.cmd "lpass import '#{escape( csv_filename )}'"
+    end
+
+    # @note lpass share subcommand sharename ...
+    def self.share
+      not_implemented!
+    end
+
+    # @note lpass --version
+    def self.version
+      Utils.cmd 'lpass --version'
+    end
+
+    private
+
+    # For methods that are not yet implemented
+    #
+    # @raise Command not implemented
+    def self.not_implemented!
+      raise 'Command not implemented!'
+    end
+
+    # Escapes single or double quotes in strings
+    #
+    # @param string [String] the string to escape
+    # @param double [Boolean] whether to escape double quotes (defaults to single quotes)
+    # @return [String] escaped string
+    def self.escape( string, double: false )
+      if double
+        string.to_s.gsub( '"', '\"' )
+      else # Assume single quotes
+        string.to_s.gsub( "'", "\\\\'" )
+      end
+    end
+
+    # Remove sync files, which can get stuck because of lpass bug
+    def self.remove_sync_files
+      puts 'Removing sync files!'.red if Lastpass.verbose
+      sleep 5 # Hopefully any prior syncs will finish before clearning out stuck ones
+      Utils.cmd "rm -f #{UPLOAD_QUEUE_PATH}/*"
+    end
+  end
+end

data/lib/lastpass-api/client.rb

@@ -0,0 +1,52 @@
+module Lastpass
+  class Client
+
+    def initialize( verbose: false )
+      Lastpass.verbose = verbose
+    end
+
+    def login( email:, password: )
+      if logged_in?
+        Cli.sync
+        return true
+      end
+      response = Cli.login( email, password: password )
+      raise "Login failed! #{response}" unless response.include? 'Success'
+      Cli.sync
+      @password = nil # Clear out password
+      true
+    end
+
+    def logout
+      return true if logged_out?
+      Cli.logout
+      true
+    rescue
+      false
+    end
+
+    def logged_in?
+      Cli.status.include? 'Logged in'
+    rescue
+      false
+    end
+
+    def logged_out?
+      !logged_in?
+    end
+
+    def accounts
+      Accounts.new
+    end
+
+    def groups
+      Groups.new
+    end
+
+    # Hide instance variables and values
+    def inspect
+      original_inspect = super
+      original_inspect.split( ' ' ).first << '>'
+    end
+  end
+end

data/lib/lastpass-api/collection.rb

@@ -0,0 +1,27 @@
+module Lastpass
+  class Collection
+
+    def find( search_text, with_password: false )
+      show( search_text, with_passwords: with_password )&.first
+    end
+
+    def find_all( search_text = '.*', with_passwords: false )
+      show( search_text, with_passwords: with_passwords, regex: true ) || []
+    end
+
+    private
+
+    def show( search_text, regex: false, with_passwords: false )
+      begin
+        response = Cli.show( search_text, expand_multi: true, all: true, basic_regexp: regex )
+      rescue => e
+        if e.message.include? 'Could not find specified account'
+          return nil # Just means nothing was found
+        else
+          raise e # Something is wrong, re-raise the exception
+        end
+      end
+      Parser.parse( response, with_passwords: with_passwords )
+    end
+  end
+end

data/lib/lastpass-api/group.rb

@@ -0,0 +1,69 @@
+module Lastpass
+  class Group
+    attr_reader :id
+    attr_accessor :name
+
+    def initialize( params )
+      params[:name].chomp!( '/' ) if params[:name]&.end_with? '/'
+      params_to_group( params )
+    end
+
+    def update( params )
+      deleted! if @deleted
+      params.delete( :id ) # Prevent overwriting ID
+      params_to_group( params )
+      save
+    end
+
+    def save
+      deleted! if @deleted
+      # If there is an ID, update that entry
+      if @id
+        Cli.edit_group( @id, name: @name )
+      else # If no ID, that means this is a new entry
+        Cli.add_group( @name )
+        set_id_after_save
+      end
+      self
+    end
+
+    def delete
+      Cli.rm( @id )
+      @deleted = true
+    end
+
+    def to_hash
+      params = {}
+      params[:id]   = @id   if @id
+      params[:name] = @name if @name
+      params
+    end
+
+    alias_method :to_h, :to_hash
+
+    # Hide instance variables and values
+    def inspect
+      original_inspect = super
+      original_inspect.split( ' ' ).first << '>'
+    end
+
+    private
+
+    def params_to_group( params )
+      @id   = params[:id]   if params[:id]
+      @name = params[:name] if params[:name]
+    end
+
+    def set_id_after_save
+      response = Cli.show( "#{@name}/", id: true )
+      if response.nil? || response == '' || response.include?( 'Multiple matches found' )
+        raise "Unable to fetch ID of newly created group! Name may have not been unique. Response: #{response}"
+      end
+      @id = response
+    end
+
+    def deleted!
+      raise "Group [ID:#{@id}] has been deleted!"
+    end
+  end
+end

data/lib/lastpass-api/groups.rb

@@ -0,0 +1,30 @@
+module Lastpass
+  class Groups < Collection
+
+    def find( search_text, with_password: false )
+      search_text << '/' unless search_text.end_with? '/'
+      params = super
+      if params.is_a?( Hash ) && params[:name]&.end_with?( '/' )
+        Group.new( params )
+      end
+    end
+
+    def find_all( search_text = '.*', with_passwords: false )
+      groups = super.select { |params| params[:name]&.end_with? '/' }
+      groups.map do |params|
+        Group.new( params )
+      end
+    end
+
+    def create( params )
+      params.delete( :id ) # Prevent overwriting ID
+      Group.new( params ).save
+    end
+
+    # Hide instance variables and values
+    def inspect
+      original_inspect = super
+      original_inspect.split( ' ' ).first << '>'
+    end
+  end
+end

data/lib/lastpass-api/parser.rb

@@ -0,0 +1,49 @@
+module Lastpass
+  class Parser
+
+    def self.parse( raw_string, with_passwords: false )
+      new( raw_string, with_passwords: with_passwords ).parse_all
+    end
+
+    def initialize( raw_string, with_passwords: false )
+      @raw_string = raw_string
+      @with_passwords = with_passwords
+      @all = {}
+    end
+
+    def parse_all
+      @raw_string.split( "\n" ).each do |line|
+        parse_line( line )
+      end
+      @all.values
+    end
+
+    # Hide instance variables and values
+    def inspect
+      original_inspect = super
+      original_inspect.split( ' ' ).first << '>'
+    end
+
+    private
+
+    def parse_line( line )
+      parent_match = line.match( /^(.+)\s\[id:\s(\d+)\]$/ )
+      child_match = line.match( /^((?!\s\[id:\s)[\s\S])*$/ )
+      if parent_match
+        parent_id = parent_match[2]
+        parent_name = parent_match[1]
+        @all[parent_id] = { id: parent_id, name: parent_name }
+        @parent_id = parent_id
+      elsif child_match
+        child_parsed_match = child_match[0].match( /^(\w+):\s(.*)$/ )
+        if child_parsed_match && @parent_id
+          key = child_parsed_match[1]
+          value = child_parsed_match[2]
+          @all[@parent_id] ||= {}
+          return if !@with_passwords && key.downcase.to_sym == :password
+          @all[@parent_id][key.downcase.to_sym] = value
+        end
+      end
+    end
+  end
+end

data/lib/lastpass-api/utils.rb

@@ -0,0 +1,34 @@
+require 'colorize'
+require 'open3'
+
+module Lastpass
+  class Utils
+
+    # Run a command
+    def self.cmd( command, output: false )
+      puts "RUN COMMAND:  #{command}".green if Lastpass.verbose
+      @stdout = ''
+      Open3::popen3( command ) do |stdin, stdout, stderr, wait_thr|
+        stdout.sync = true
+        while line = stdout.gets
+          puts line if Lastpass.verbose || output
+          @stdout << line
+        end
+
+        exit_status = wait_thr.value
+        unless exit_status.success?
+          puts "COMMAND:  #{command}".red if Lastpass.verbose
+          stderr_text = stderr.read
+          puts stderr_text.red if Lastpass.verbose
+          raise StandardError, "Command: '#{command}', Stdout: '#{stdout.read}', Stderr: '#{stderr_text}'"
+        end
+      end
+
+      return @stdout
+    rescue Errno::ENOENT => e
+      puts "COMMAND:  #{command}".red if Lastpass.verbose
+      puts "#{e}".red if Lastpass.verbose
+      raise StandardError, "Command: '#{command}', Error: '#{e}'"
+    end
+  end
+end

data/lib/lastpass-api/version.rb

@@ -0,0 +1,3 @@
+module Lastpass
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: lastpass-api
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Eric Terry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: Full access to the LastPass vault to create, read, and update account
+  information and credentials.
+email:
+- eterry1388@aol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- lastpass-api.gemspec
+- lib/lastpass-api.rb
+- lib/lastpass-api/account.rb
+- lib/lastpass-api/accounts.rb
+- lib/lastpass-api/cli.rb
+- lib/lastpass-api/client.rb
+- lib/lastpass-api/collection.rb
+- lib/lastpass-api/group.rb
+- lib/lastpass-api/groups.rb
+- lib/lastpass-api/parser.rb
+- lib/lastpass-api/utils.rb
+- lib/lastpass-api/version.rb
+homepage: http://www.entretechno.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Read/Write access to the online LastPass vault using LastPass CLI
+test_files: []