seamapi 1.16.1 → 1.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 59707fd30b06cfed95a0faa28ea666dbcff8d9b55ffdfb15bf22ac094e6d56c0
4
- data.tar.gz: 6df4cafd7db4c6d0a61e63ab2a1aeb8dc30a3f830792ab87ceb3d775669ebd54
3
+ metadata.gz: 1e08c1f8b5bba3cdc3b7e01dbba61793f12fabef56de9bee0f237ad7f1c47c01
4
+ data.tar.gz: 173a8dd673f5fb94b7ccff36a8bb6d1c7d25afa612652e7a453fdde0058701c5
5
5
  SHA512:
6
- metadata.gz: a61158ebb0e4d931e4572cd7799c0d84ac48169db48e79565ac64f42f78aa743a221d0bf837d7399026ec282b871a22c6ef3ef6d3805ddc20889df509d5d15a1
7
- data.tar.gz: 640f24b2e312bb8274b6f78acd6edd4cb66c7563c282ae7115c5f2e5d0f356d0210294529396910fd2559a2aed6cfe812f4428bd7e2fcbab09ff7a61b74f964c
6
+ metadata.gz: a5977aea3734de898cfe1dca3b3d779fa153a82a9610a214ab2fe76cd2bd328e1fee7683b45cce9d7349bdf386702c0b1c78dc236f3ad3a7e195a2b9ca954949
7
+ data.tar.gz: 14e9f4f48557598aa8de2ae4366eed46462afea8304148126362891cd111225e8a4f2175467cc5908a964dc0c6e5a636cf6f01a436f5d4df954a93c0a6655978
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- seamapi (1.16.1)
4
+ seamapi (1.17.0)
5
5
  http (~> 5.0)
6
6
 
7
7
  GEM
@@ -11,27 +11,29 @@ GEM
11
11
  public_suffix (>= 2.0.2, < 6.0)
12
12
  ansi (1.5.0)
13
13
  ast (2.4.2)
14
+ base64 (0.2.0)
14
15
  crack (0.4.5)
15
16
  rexml
16
17
  diff-lcs (1.5.0)
17
18
  docile (1.4.0)
18
- domain_name (0.6.20231109)
19
- ffi (1.16.3)
20
- ffi-compiler (1.0.1)
21
- ffi (>= 1.0.0)
19
+ domain_name (0.6.20240107)
20
+ ffi (1.17.0)
21
+ ffi-compiler (1.3.2)
22
+ ffi (>= 1.15.5)
22
23
  rake
23
24
  gem-release (2.2.2)
24
25
  hashdiff (1.0.1)
25
- http (5.1.1)
26
+ http (5.2.0)
26
27
  addressable (~> 2.8)
28
+ base64 (~> 0.1)
27
29
  http-cookie (~> 1.0)
28
30
  http-form_data (~> 2.2)
29
- llhttp-ffi (~> 0.4.0)
30
- http-cookie (1.0.5)
31
+ llhttp-ffi (~> 0.5.0)
32
+ http-cookie (1.0.7)
31
33
  domain_name (~> 0.5)
32
34
  http-form_data (2.3.0)
33
35
  json (2.6.2)
34
- llhttp-ffi (0.4.0)
36
+ llhttp-ffi (0.5.0)
35
37
  ffi-compiler (~> 1.0)
36
38
  rake (~> 13.0)
37
39
  multi_json (1.15.0)
data/README.md CHANGED
@@ -1,182 +1,2 @@
1
- # Seam API Ruby SDK
2
-
3
- [![RubyGems.org](https://img.shields.io/gem/v/seamapi)](https://rubygems.org/gems/seamapi)
4
- [![GitHub Actions](https://github.com/seamapi/ruby/workflows/main/badge.svg)](https://github.com/seamapi/ruby/actions)
5
- [![Docs](https://img.shields.io/badge/docs-latest-blue)](https://docs.seam.co/)
6
-
7
- Official interface to the [Seam Connect API].
8
-
9
- [Seam Connect API]: https://docs.seam.co/
10
-
11
- ## Description
12
-
13
- This SDK provides convenient access to the [Seam Connect API] for Ruby applications.
14
-
15
- This library includes:
16
-
17
- - A predefined set of classes for API resources that
18
- initialize themselves dynamically from API responses.
19
- - Methods for all [Seam API endpoints](https://docs.seam.co/latest/api-clients/overview).
20
- - Simplified asynchronous flows, e.g., listening for events or actions to finish.
21
-
22
- [Seam API endpoints]: https://docs.seam.co/latest/api-endpoints/overview
23
-
24
- ## Installation
25
-
26
- Add this as a dependency to your project using [Bundler] with
27
-
28
- ```
29
- $ bundle add seamapi
30
- ```
31
-
32
- [bundler]: https://bundler.io/
33
-
34
- ## Usage
35
-
36
- _Refer to the [Seam Connect API documentation][Seam Connect API]._
37
-
38
- ### Requirements
39
-
40
- - Ruby version 3 or later.
41
- - An API Key generated via the [Seam Dashboard].
42
-
43
- [Seam Dashboard]: https://dashboard.getseam.com
44
-
45
- ### Example
46
-
47
- ```ruby
48
- seam = Seam::Client.new(api_key: "MY_SEAM_API_KEY")
49
- devices = seam.devices.list
50
- my_door = devices.first
51
- seam.locks.unlock(my_door).wait_until_finished
52
- ```
53
-
54
- ## Development and Testing
55
-
56
- ### Quickstart
57
-
58
- ```
59
- $ git clone https://github.com/seamapi/ruby.git
60
- $ cd ruby
61
- $ bundle install
62
- ```
63
-
64
- Run the command below
65
-
66
- ```
67
- $ bundle exec rake
68
- ```
69
-
70
- Open an interactive ruby console with
71
-
72
- ```
73
- $ bundle exec rake
74
- ```
75
-
76
- Primary development tasks are defined as [rake] tasks in the `Rakefile`
77
- and available via `rake`.
78
- View them with
79
-
80
- ```
81
- $ bundle exec rake -T
82
- ```
83
-
84
- [rake]: https://ruby.github.io/rake/
85
-
86
- ### Interactive Console
87
-
88
- Play around with this module inside an interactive console with
89
-
90
- ```
91
- $ rake console
92
- ```
93
-
94
- Use a sandbox API key to play with the SDK without touching real devices.
95
-
96
- ### Source code
97
-
98
- The [source code] is hosted on GitHub.
99
- Clone the project with
100
-
101
- ```
102
- $ git clone git@github.com:seamapi/ruby.git
103
- ```
104
-
105
- [source code]: https://github.com/seamapi/ruby
106
-
107
- ### Requirements
108
-
109
- You will need [Ruby] with [Bundler].
110
-
111
- Be sure that all commands run under the correct Ruby version, e.g.,
112
- if using [rbenv], install the correct version with
113
-
114
- ```
115
- $ rbenv install
116
- ```
117
-
118
- Install the development dependencies with
119
-
120
- ```
121
- $ bundle install
122
- ```
123
-
124
- [bundler]: https://bundler.io/
125
- [ruby]: https://www.ruby-lang.org/
126
- [rbenv]: https://github.com/rbenv/rbenv
127
-
128
- ### Publishing
129
-
130
- Releases are handled automatically by [semantic-release].
131
- Publishing may be triggered manually using a [workflow_dispatch on GitHub Actions].
132
-
133
- [semantic-release]: https://semantic-release.gitbook.io/
134
- [workflow_dispatch on github actions]: https://github.com/seamapi/ruby/actions?query=workflow%3Aversion
135
-
136
- ## GitHub Actions
137
-
138
- _GitHub Actions should already be configured: this section is for reference only._
139
-
140
- The following repository secrets must be set on [GitHub Actions]:
141
-
142
- - `RUBYGEMS_API_KEY`: RubyGems.org token for publishing packages.
143
- - `GH_TOKEN`: A personal access token for the user.
144
- - `GIT_USER_NAME`: The GitHub user's real name.
145
- - `GIT_USER_EMAIL`: The GitHub user's email.
146
- - `GPG_PRIVATE_KEY`: The GitHub user's [GPG private key].
147
- - `GPG_PASSPHRASE`: The GitHub user's GPG passphrase.
148
-
149
- These are set at the organization level.
150
-
151
- [github actions]: https://github.com/features/actions
152
- [gpg private key]: https://github.com/marketplace/actions/import-gpg#prerequisites
153
-
154
- ## Contributing
155
-
156
- Please submit and comment on bug reports and feature requests.
157
-
158
- To submit a patch:
159
-
160
- 1. Fork it (https://github.com/seamapi/ruby/fork).
161
- 2. Create your feature branch (`git checkout -b my-new-feature`).
162
- 3. Make changes.
163
- 4. Commit your changes (`git commit -am 'Add some feature'`).
164
- 5. Push to the branch (`git push origin my-new-feature`).
165
- 6. Create a new Pull Request.
166
-
167
- ## License
168
-
169
- This Ruby gem is licensed under the MIT license.
170
-
171
- ## Warranty
172
-
173
- This software is provided by the copyright holders and contributors "as is" and
174
- any express or implied warranties, including, but not limited to, the implied
175
- warranties of merchantability and fitness for a particular purpose are
176
- disclaimed. In no event shall the copyright holder or contributors be liable for
177
- any direct, indirect, incidental, special, exemplary, or consequential damages
178
- (including, but not limited to, procurement of substitute goods or services;
179
- loss of use, data, or profits; or business interruption) however caused and on
180
- any theory of liability, whether in contract, strict liability, or tort
181
- (including negligence or otherwise) arising in any way out of the use of this
182
- software, even if advised of the possibility of such damage.
1
+ This package has moved to [seam](https://rubygems.org/gems/seam).
2
+ Please refer to the [migration guide](https://github.com/seamapi/ruby/releases/tag/v2.0.0).
data/lib/seam/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Seam
4
- VERSION = "1.16.1"
4
+ VERSION = "1.17.0"
5
5
  end
data/lib/seamapi.rb CHANGED
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ puts("\nThe seamapi gem has been moved to seam. \nPlease refer to the migration guide at https://github.com/seamapi/ruby/releases/tag/v2.0.0\n\n")
4
+
3
5
  require_relative "seam/version"
4
6
  require_relative "seam/request"
5
7
  require_relative "seam/logger"
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: seamapi
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.16.1
4
+ version: 1.17.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Seam Labs, Inc.
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-12-21 00:00:00.000000000 Z
11
+ date: 2024-11-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: http