stytch 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e297565a826ab7318a1471d3b4286bba6d8a58c1f335bb5fe39b31355dad8bb0
-  data.tar.gz: 6d5873eed220a0d85539b0264408757451ce18e106dd58cf5b747543697808cc
+  metadata.gz: f10d2ac983b6812590a7d1d01fa649ea9a84bcdbff28cdc34b47dc6e075ebcaf
+  data.tar.gz: '08dbadda02435370eceb0d66533a11631c05ab615e646a0d6fa77d58fb579bdb'
 SHA512:
-  metadata.gz: bcec30dcf3b4e89293bb41f05202aca38b6b46d2a42531d9cae2471a1b6c8a7052bca1aa962a4017a2486b92a0f1c24b7634c59c3ed8725f3763d17a6162cef7
-  data.tar.gz: 36d398ca7e3a987cb94efa45875d17473dfdd348266474e9c2f29ec6a1491a0bf001a1960f9ed712f946904daf0265f79e851689a7ff9cb9cf6e546d843d64af
+  metadata.gz: 5d084490ad18ef02b1f9215356be00e987379b773652a42c22e95058ff38631e8d0d020a93361f1b70c56041451d25e71daf3e6b896e27022185d46045b4fdd0
+  data.tar.gz: e62da9085f0263fe06c5134747f2b5a5992d6163333a90197e1ab0e1aa2379e7a8d73124fe2d93c443ca1431d36447b64735e2086edc1e73eebfd359b33e8d25

data/CODEOWNERS

@@ -0,0 +1,7 @@
+# Stytch code owners file
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# @stytchauth/client-libraries will be requested for
+# review when someone opens a pull request.
+*       @stytchauth/client-libraries

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ 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 alex@stytch.com. All
+reported by contacting the project team at support@stytch.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.

data/DEVELOPMENT.md

@@ -0,0 +1,18 @@
+# Development
+
+Thanks for contributing to Stytch's Ruby library! If you run into trouble, find us in [Slack].
+
+## Setup
+
+1. Clone this repo.
+2. To test your changes locally, update your GEMFILE with `gem 'stytch', path: '../stytch'` where `../stytch` is the path to your cloned copy of stytch-ruby.
+
+## Issues and Pull Requests
+
+Please file issues in this repo. We don't have an issue template yet, but for now, say whatever you think is important!
+
+If you have non-trivial changes you'd like us to incorporate, please open an issue first so we can discuss the changes before starting on a pull request. (It's fine to start with the PR for a typo or simple bug.) If we think the changes align with the direction of the project, we'll either ask you to open the PR or assign someone on the Stytch team to make the changes.
+
+When you're ready for someone to look at your issue or PR, assign `@stytchauth/client-libraries` (GitHub should do this automatically). If we don't acknowledge it within one business day, please escalate it by tagging `@stytchauth/engineering` in a comment or letting us know in [Slack].
+
+[Slack]: https://join.slack.com/t/stytch/shared_invite/zt-nil4wo92-jApJ9Cl32cJbEd9esKkvyg

data/README.md

@@ -1,8 +1,10 @@
-# Stytch
+# Stytch Ruby Gem
 
-Welcome to the official Stytch ruby gem! This gem provides easy access to Stytch's API.
+The Stytch Ruby gem makes it easy to use the Stytch user infrastructure API in Ruby applications.
 
-## Installation
+It pairs well with the Stytch [Web SDK](https://www.npmjs.com/package/@stytch/stytch-js) or your own custom authentication flow.
+
+## Install
 
 Add this line to your application's Gemfile:
 
@@ -20,25 +22,61 @@ Or install it yourself as:
 
 ## Usage
 
-To make a request, first create a Stytch Client.
-Set `env` to either `:test` or `:api` depending on which environment you want to use.
-```
+You can find your API credentials in the [Stytch Dashboard](https://stytch.com/dashboard/api-keys).
+
+Create an API client:
+```ruby
 client = Stytch::Client.new(
-    env: :test,
+    env: :test, # available environments are :test and :live
     project_id: "***",
     secret: "***"
 )
 ```
 
-Then make desired API call.
+Send a magic link by email:
+```ruby
+client.magic_links.email.login_or_create(
+    email: "sandbox@stytch.com",
+    login_magic_link_url: "https://example.com/login",
+    signup_magic_link_url: "https://example.com/signup",
+)
 ```
-client.users.get(user_id: user_id)
+
+Authenticate the token from the magic link:
+```ruby
+client.magic_links.authenticate(
+    token: "DOYoip3rvIMMW5lgItikFK-Ak1CfMsgjuiCyI7uuU94=",
+)
 ```
 
+## Handling Errors
+
+When possible the response will contain an `error_type` and an `error_message` that can be used to distinguish errors.
+
+Learn more about errors in the [docs](https://stytch.com/docs/api/errors).
+
+## Documentation
+
+See example requests and responses for all the endpoints in the [Stytch API Reference](https://stytch.com/docs/api).
+
+Follow one of the [integration guides](https://stytch.com/docs/guides) or start with one of our [example apps](https://stytch.com/docs/example-apps).
+
+## Support
+
+If you've found a bug, [open an issue](https://github.com/stytchauth/stytch-ruby/issues/new)!
+
+If you have questions or want help troubleshooting, join us in [Slack](https://join.slack.com/t/stytch/shared_invite/zt-nil4wo92-jApJ9Cl32cJbEd9esKkvyg) or email support@stytch.com.
+
+If you've found a security vulnerability, please follow our [responsible disclosure instructions](https://stytch.com/docs/security).
+
+## Development
+
+See [DEVELOPMENT.md](DEVELOPMENT.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 Stytch project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/stytchauth/stytch-ruby/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Stytch project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).

data/lib/stytch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stytch
-  VERSION = '2.1.0'
+  VERSION = '2.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stytch
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - stytch
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-30 00:00:00.000000000 Z
+date: 2021-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -60,7 +60,9 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CODEOWNERS
 - CODE_OF_CONDUCT.md
+- DEVELOPMENT.md
 - Gemfile
 - LICENSE.txt
 - README.md