op_connect 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '04619cb5c704b7ce616e03250fbc321dbfd0d6682a391c31158a12336165935d'
+  data.tar.gz: 9ee0335c82ac5593ec4789e0882b787b6033364f84fb4030a4cab852c4b5646e
+SHA512:
+  metadata.gz: 5b6007f3d1db23525862b0063ee18e62129230d8d21a4cee6a4253a1edd73af1beb8dde70229117db7eb26a0bef2056493d0187f5d5197890086f346452b5c20
+  data.tar.gz: b0575f5782b12e9298554fe6fcf1750dcb6b2f5d8efe7c7a1af98baa88189f2428a70a4e32fedee5dd421e99897ec13bda040e36c0aa0aee3e0232c36158c806

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: partydrone
+
+---
+
+## Describe the bug
+A clear and concise description of what the bug is.
+
+## To Reproduce
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+## Expected behavior
+A clear and concise description of what you expected to happen.
+
+## Screenshots
+If applicable, add screenshots to help explain your problem.
+
+## Environment
+ - Gem version:
+ - Ruby version:
+
+## Additional context
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: partydrone
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/workflows/coverage.yml

@@ -0,0 +1,27 @@
+name: Report Test Coverage
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.0'
+          bundler: default
+          bundler-cache: true
+
+      - uses: paambaati/codeclimate-action@v2.7.5
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        with:
+          coverageCommand: bundle exec rake test
+          coverageLocations: |
+            ${{ github.workspace }}/test/coverage/lcov/*.lcov:lcov

data/.github/workflows/publish.yml

@@ -0,0 +1,42 @@
+name: Publish
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 3.0
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+
+      - name: Publish to GitHub
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+        env:
+          GEM_HOST_API_KEY: 'Bearer ${{secrets.GITHUB_TOKEN}}'
+          OWNER: ${{ github.repository_owner }}
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: '${{secrets.RUBYGEMS_AUTH_TOKEN}}'

data/.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.6', '2.7', '3.0']
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler: default
+          bundler-cache: true
+      - name: Check coding standards
+        run: bundle exec standardrb
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/test/coverage/
+/tmp/
+Gemfile.lock
+1password-credentials.json

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at partydrone@icloud.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in op_connect.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "minitest-reporters"
+gem "guard"
+gem "guard-minitest"
+gem "standard"
+gem "simplecov", require: false
+gem "simplecov-lcov", require: false
+gem "simplecov-tailwindcss", require: false

data/Guardfile

@@ -0,0 +1,23 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest, all_on_start: false do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)_test\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^test/test_helper\.rb$}) { "test" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Andrew Porter
+
+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,322 @@
+# 1Password Connect Ruby SDK
+
+![example workflow](https://github.com/partydrone/connect-sdk-ruby/actions/workflows/test.yml/badge.svg) [![Maintainability](https://api.codeclimate.com/v1/badges/e5d93bbb1ec1b779aada/maintainability)](https://codeclimate.com/github/partydrone/connect-sdk-ruby/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/e5d93bbb1ec1b779aada/test_coverage)](https://codeclimate.com/github/partydrone/connect-sdk-ruby/test_coverage)
+
+<img width="1012" alt="op_connect_banner" src="https://user-images.githubusercontent.com/57892/139618110-63e92aa3-794a-463b-b72a-d6a5909a5b8a.png">
+
+The 1Password Connect Ruby SDK provides access to the 1Password Connect API
+hosted on your infrastructure. The gem is intended to be used by your
+applications, pipelines, and other automations to simplify accessing items
+stored in your 1Password vaults.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'op_connect'
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+Or install it yourself as:
+
+```sh
+gem install op_connect
+```
+
+## Configuration and Defaults
+
+While `OpConnect::Client` accepts a range of options when creating a new client
+instance, OpConnect's configuration API allows you to set your configuration
+options at the module level. This is particularly handy if you're creating a
+number of client instances based on some shared defaults. Changing options
+affects new instances only and will not modify existing `OpConnect::Client`
+instances created with previous options.
+
+### Configuring module defaults
+
+Every writable attribute in `OpConnect::Configurable` can be set one at a time:
+
+```ruby
+OpConnect.api_endpoint = "http://localhost:8080/v1"
+OpConnect.access_token = "secret_access_token"
+```
+
+Or in a batch:
+
+```ruby
+OpConnect.configure do |config|
+  config.api_endpoint = "http://localhost:8080/v1"
+  config.access_token = "secret_access_token"
+end
+```
+
+### Using ENV variables
+
+Default configuration values are specified in `OpConnect::Default`. Many attributes look for a
+default value from ENV before returning OpConnect's default.
+
+| Variable                  | Description                                                                   | Default                                         |
+| ------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------- |
+| `OP_CONNECT_ACCESS_TOKEN` | The API token used to authenticate the client to a 1Password Connect API.     |                                                 |
+| `OP_CONNECT_API_ENDPOINT` | The URL of the 1Password Connect API server.                                  | <http://localhost:8080/v1>                      |
+| `OP_CONNECT_USER_AGENT`   | The user-agent string the client uses when making requests. This is optional. | 1Password Connect Ruby SDK {OpConnect::VERSION} |
+
+## Usage
+
+### Making requests
+
+API methods are available as client instance methods.
+
+```ruby
+# Provide an access token
+client = OpConnect::Client.new(access_token: "secret_access_token")
+
+# Fetch a list of vaults
+client.vaults
+```
+
+### Using query parameters
+
+You can pass query parameters to some GET-based requests.
+
+```ruby
+client.vaults filter: "title eq 'Secrets Automation'"
+```
+
+> 👀 For more information, see the [API documentation][api_docs].
+
+### Consuming resources
+
+Most methods return an object which provides convenient dot notation for fields
+returned in the API response.
+
+#### List vaults
+
+```ruby
+vaults = client.vaults
+# => [#<OpConnect::Vault:0x00007fae27198610 …
+vaults.first.id
+# => "alynbizzypgx62nti6zxajloei"
+```
+
+#### Get vault details
+
+```ruby
+vault = client.vault(id: "alynbizzypgx62nti6zxajloei")
+# => #<OpConnect::Vault:0x00007fae200c1a18 …
+```
+
+#### List items
+
+```ruby
+items = client.items(vault_id: vault.id)
+# => [#<OpConnect::Item:0x00007fae27151490 …
+```
+
+#### Add item
+
+The request must include a `FullItem` object containing the information to
+create the item.
+
+> 👀 See the [API documentation](https://support.1password.com/connect-api-reference/#add-an-item)
+> for an example.
+
+```ruby
+attributes = {
+  vault: {
+    id: vault.id
+  },
+  title: "Secrets Automation Item",
+  category: "LOGIN",
+  fields: [
+    {
+      value: "wendy",
+      purpose: "USERNAME"
+    },
+    {
+      purpose: "PASSWORD",
+      generate: true,
+      recipe: {
+        length: 55,
+        characterSets: ["LETTERS", "DIGITS"]
+      }
+    }
+  ]
+  # …
+}
+
+item = client.create_item(vault_id: vault.id, body: attributes)
+# => #<OpConnect::Item:0x00007fae27151490 …
+```
+
+#### Get item details
+
+```ruby
+item = client.item(vault_id: vault.id, id: "yqthoh76cfzpbsimk6zixshosq")
+# => #<OpConnect::Item:0x00007fae27151490 …
+item.title
+# => "AWS IAM Account"
+item.favorite?
+# => false
+```
+
+#### Replace an item
+
+```ruby
+attributes = {
+  vault: {
+    id: vault.id
+  },
+  title: "Secrets Automation Item",
+  category: "LOGIN",
+  fields: [
+    {
+      value: "jonathan",
+      purpose: "USERNAME"
+    },
+    {
+      purpose: "PASSWORD",
+      generate: true,
+      recipe: {
+        length: 55,
+        characterSets: ["LETTERS", "DIGITS"]
+      }
+    }
+  ]
+  # …
+}
+
+item = client.replace_item(vault_id: vault.id, id: item.id, body: attributes)
+# => #<OpConnect::Item:0x00007fae27151490 …
+```
+
+> 👀 See the [API documentation](https://support.1password.com/connect-api-reference/#add-an-item)
+> for an explanation and list of fields and object structure.
+
+#### Change item details
+
+Use the [JSON Patch](https://tools.ietf.org/html/rfc6902) document standard to
+compile a series of operations to make more targeted changes to an item.
+
+> 👀 See the [API documentation](https://support.1password.com/connect-api-reference/#change-item-details)
+> for more information.
+
+```ruby
+attributes = [
+  {op: "replace", path: "/title", value: "New Secrets Automation Item"},
+  {op: "replace", path: "/fields/username", value: "tinkerbell"}
+]
+
+item = client.update_item(vault_id: vault.id, id: item.id, body: attributes)
+# => #<OpConnect::Item:0x00007fae27151490 …
+```
+
+#### Delete an item
+
+```ruby
+client.delete_item(vault_id: vault.id, id: item.id)
+# => true
+```
+
+#### List files
+
+```ruby
+files = client.files(vault_id: vault.id, item_id: item.id)
+# => [#<OpConnect::Item::File:0x00007fae27151490 …
+```
+
+#### Get file details
+
+```ruby
+file = client.file(vault_id: vault.id, item_id: item.id, id: "6r65pjq33banznomn7q22sj44e")
+# => #<OpConnect::Item::File:0x00007fae27151490 …
+```
+
+#### Get file content
+
+```ruby
+content = client.file(vault_id: vault.id, item_id: item.id, id: file.id)
+# => "The future belongs to the curious.\n"
+```
+
+#### List API activity
+
+Retrieve a list of API requests made to the server.
+
+```ruby
+client.activity
+# => [#<OpConnect::APIRequest:0x00007fae27151490 …
+```
+
+#### Check server for a heartbeat
+
+Ping the server to check if it's active or not.
+
+```ruby
+client.heartbeat
+# => true
+```
+
+#### Get server health info
+
+Query the state of the server and its service dependencies.
+
+```ruby
+client.health
+# => #<OpConnect::ServerHealth:0x00007fae27151490 …
+```
+
+#### Get server metrics
+
+This returns Prometheus metrics collected by the server.
+
+```ruby
+client.metrics
+# => "# HELP go_gc_duration_seconds A summary of the pause duration of …
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Running a local 1Password Connect API server
+
+This project includes a docker-compose.yml file that will download and run an
+API and Sync server for you to test with locally. You will need to:
+
+- [ ] Install Docker, Docker for Mac, or Docker for Windows.
+- [ ] Place your 1password-credentials.json file in the root of this project.
+
+> 👀 See [Get started with a 1Password Secrets Automation workflow][secrets_automation_workflow]
+> for more information.
+
+### Resources
+
+Some links that are definitely worth checking out:
+
+- [1Password Secrets Automation](https://1password.com/secrets/)
+- [Get started with a 1Password Secrets Automation workflow][secrets_automation_workflow]
+- [1Password Connect API reference][api_docs]
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/partydrone/connect-sdk-ruby>. 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/partydrone/connect/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Connect project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/partydrone/connect/blob/main/CODE_OF_CONDUCT.md).
+
+[api_docs]: https://support.1password.com/connect-api-reference '1Password Connect API reference'
+[secrets_automation_workflow]: https://support.1password.com/secrets-automation/ 'Get started with a 1Password Secrets Automation workflow'

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "op_connect"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+client ||= OpConnect.client
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here