screenshots_pagepixels 1.0.0 → 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 20a62b5eca4d9d981ceff650494787478b56810b4ddb30e543bc4a8aaee9aaeb
4
- data.tar.gz: 82c12736d4dd429fa36023b6cc401bf92f3f59f0fb4d1d66b83b091f6e8ea4ea
3
+ metadata.gz: 805c303d5a8a4c9ac35439d67b43e7c7fdc109f66c7aab8f79a1f5b24f7a1fef
4
+ data.tar.gz: a7d2511e9071ffd774d2563ff2a0210c7e97e2a61021da7cbdd6dd6f4dbdf25f
5
5
  SHA512:
6
- metadata.gz: 5cd44d16146cd75d9dc782bf1267af031b8c3103903a505d3d2aa9060f582fb26316d3ecbe45b4c02afa3315de00c023beb50c68db12e4910f511f1eaa4ee3fc
7
- data.tar.gz: 5e689ddfd6067f07888571d2c1bd334a23bbe1d8542e6709df7312566cbbd3812ce90ae96889915328a141fd90c273abb67e610f75742aa6c36334dd38e8de25
6
+ metadata.gz: ca29c4830a6a0f514dca051be60af9733197fec1ea0be1648f6b90a5d01ffe5aebdc763b7c3db769c52474826beef03090fc2cb43c1c072722b118fbb49e9b14
7
+ data.tar.gz: d7127206320265e7e972f242c5e6a0868b4b93566939cf17099b5f7a740fb7a303d5d3ad6a56027f6e956feb2e00b7268270140f6e1ff55a977aecb622447c8d
data/CHANGELOG.md CHANGED
@@ -1,5 +1,5 @@
1
1
  ## [Unreleased]
2
2
 
3
- ## [0.1.0] - 2023-05-05
3
+ ## [1.0.0] - 2023-05-05
4
4
 
5
5
  - Initial release
data/README.md CHANGED
@@ -30,9 +30,9 @@ require 'screenshots_pagepixels'
30
30
  ```
31
31
 
32
32
  ## Usage
33
- The `PagePixelsScreenshots` RubyGem provides a simple and intuitive way to interface with the PagePixels API. The `PagePixelsScreenshots::Client` class provides the following methods.
33
+ The `ScreenshotsPagepixels` RubyGem provides a simple and intuitive way to interface with the PagePixels API. The `ScreenshotsPagepixels::Client` class provides the following methods.
34
34
 
35
- Learn more about configuring your screenshots for your needs by here:
35
+ Learn more about configuring your screenshot options here:
36
36
 
37
37
  https://pagepixels.com/app/documentation#api-options
38
38
 
@@ -42,13 +42,13 @@ Captures a screenshot of a web page immediately.
42
42
  ```ruby
43
43
  require 'screenshots_pagepixels'
44
44
 
45
- client = PagePixelsScreenshots::Client.new('your-api-key')
45
+ client = ScreenshotsPagepixels::Client.new('your-api-key')
46
46
  options = { url: 'https://www.example.com' }
47
47
  client.snap(options)
48
48
  ```
49
49
 
50
50
  ### `create_screenshot_config(options = {})`
51
- Creates a new screenshot configuration, which can include a automatically recurring schedule, multi-step configurations, and more.
51
+ Creates a new screenshot configuration, which can include an automatically recurring schedule, multi-step configurations, and more.
52
52
 
53
53
  Learn more about multi-step (click links, complete forms, login to websites, etc) functionality here:
54
54
 
@@ -61,7 +61,7 @@ https://pagepixels.com/app/documentation#scheduled-screenshots
61
61
  ```ruby
62
62
  require 'screenshots_pagepixels'
63
63
 
64
- client = PagePixelsScreenshots::Client.new('your-api-key')
64
+ client = ScreenshotsPagepixels::Client.new('your-api-key')
65
65
  options = { url: 'https://www.example.com', scheduled_screenshot: true, scheduled_every: 1, scheduled_interval: 'days' }
66
66
  client.create_screenshot_config(options)
67
67
  ```
@@ -72,7 +72,7 @@ Allows you to retrieve your screenshot configurations.
72
72
  ```ruby
73
73
  require 'screenshots_pagepixels'
74
74
 
75
- client = PagePixelsScreenshots::Client.new('your-api-key')
75
+ client = ScreenshotsPagepixels::Client.new('your-api-key')
76
76
  client.screenshot_configs
77
77
  ```
78
78
 
@@ -82,7 +82,7 @@ Gets a specific screenshot configuration.
82
82
  ```ruby
83
83
  require 'screenshots_pagepixels'
84
84
 
85
- client = PagePixelsScreenshots::Client.new('your-api-key')
85
+ client = ScreenshotsPagepixels::Client.new('your-api-key')
86
86
  client.get_screenshot_config('your-screenshot-config-id')
87
87
  ```
88
88
 
@@ -92,7 +92,7 @@ Updates a specific screenshot configuration.
92
92
  ```ruby
93
93
  require 'screenshots_pagepixels'
94
94
 
95
- client = PagePixelsScreenshots::Client.new('your-api-key')
95
+ client = ScreenshotsPagepixels::Client.new('your-api-key')
96
96
  options = { scheduled_every: 2 }
97
97
  client.update_screenshot_config('your-screenshot-config-id', options)
98
98
  ```
@@ -103,7 +103,7 @@ Deletes a specific screenshot configuration.
103
103
  ```ruby
104
104
  require 'screenshots_pagepixels'
105
105
 
106
- client = PagePixelsScreenshots::Client.new('your-api-key')
106
+ client = ScreenshotsPagepixels::Client.new('your-api-key')
107
107
  client.delete_screenshot_config('your-screenshot-config-id')
108
108
  ```
109
109
 
@@ -113,7 +113,7 @@ Retrieves a list of screenshots that were taken with a specific screenshot confi
113
113
  ```ruby
114
114
  require 'screenshots_pagepixels'
115
115
 
116
- client = PagePixelsScreenshots::Client.new('your-api-key')
116
+ client = ScreenshotsPagepixels::Client.new('your-api-key')
117
117
  client.screenshot_config_screenshots('your-screenshot-config-id')
118
118
  ```
119
119
 
@@ -127,7 +127,7 @@ https://pagepixels.com/app/documentation#screenshot-change-notifications
127
127
  ```ruby
128
128
  require 'screenshots_pagepixels'
129
129
 
130
- client = PagePixelsScreenshots::Client.new('your-api-key')
130
+ client = ScreenshotsPagepixels::Client.new('your-api-key')
131
131
  client.screenshot_config_change_notifications('your-screenshot-config-id')
132
132
  ```
133
133
 
@@ -137,7 +137,7 @@ Retrieves the status of a specific screenshot job associated with a screenshot c
137
137
  ```ruby
138
138
  require 'screenshots_pagepixels'
139
139
 
140
- client = PagePixelsScreenshots::Client.new('your-api-key')
140
+ client = ScreenshotsPagepixels::Client.new('your-api-key')
141
141
  client.job_status('your-job-id')
142
142
  ```
143
143
 
@@ -147,7 +147,7 @@ Immediately captures a screenshot using a specific screenshot configuration. Thi
147
147
  ```ruby
148
148
  require 'screenshots_pagepixels'
149
149
 
150
- client = PagePixelsScreenshots::Client.new('your-api-key')
150
+ client = ScreenshotsPagepixels::Client.new('your-api-key')
151
151
  client.capture_screenshot('your-screenshot-config-id')
152
152
  ```
153
153
 
@@ -157,7 +157,7 @@ Retrieves a list of all screenshots taken with your PagePixels account.
157
157
  ```ruby
158
158
  require 'screenshots_pagepixels'
159
159
 
160
- client = PagePixelsScreenshots::Client.new('your-api-key')
160
+ client = ScreenshotsPagepixels::Client.new('your-api-key')
161
161
  client.screenshots
162
162
  ```
163
163
 
@@ -167,7 +167,7 @@ Provides an array of all Change Notifications for all screenshot configurations.
167
167
  ```ruby
168
168
  require 'screenshots_pagepixels'
169
169
 
170
- client = PagePixelsScreenshots::Client.new('your-api-key')
170
+ client = ScreenshotsPagepixels::Client.new('your-api-key')
171
171
  client.change_notifications
172
172
  ```
173
173
 
@@ -187,6 +187,10 @@ The following options are available for scheduling:
187
187
  ## Multi-Step Screenshots
188
188
  PagePixels also provides the ability to use multi-step functionality to complete forms, navigate to different pages, click links and buttons, and login to your favorite websites prior to taking your screenshot.
189
189
 
190
+ Learn more about how to configure multi-step actions for your screenshots here:
191
+
192
+ https://pagepixels.com/app/documentation#multi-step-screenshots
193
+
190
194
  The following actions are available for use with the multi-step functionality:
191
195
 
192
196
  | Action | Example |
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module ScreenshotsPagepixels
4
- VERSION = "1.0.0"
4
+ VERSION = "1.0.1"
5
5
  end
@@ -15,8 +15,8 @@ Gem::Specification.new do |spec|
15
15
  spec.required_ruby_version = ">= 2.6.0"
16
16
 
17
17
  spec.metadata["homepage_uri"] = spec.homepage
18
- spec.metadata["source_code_uri"] = "https://github.com/PagePixels/screenshots_pagepixels-ruby"
19
- spec.metadata["changelog_uri"] = "https://github.com/PagePixels/screenshots_pagepixels-ruby/CHANGELOG.md"
18
+ spec.metadata["source_code_uri"] = "https://github.com/PagePixels/screenshots-pagepixels-ruby"
19
+ spec.metadata["changelog_uri"] = "https://github.com/PagePixels/screenshots-pagepixels-ruby/CHANGELOG.md"
20
20
 
21
21
  # Specify which files should be added to the gem when it is released.
22
22
  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: screenshots_pagepixels
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - PagePixels LLC
@@ -66,8 +66,8 @@ licenses:
66
66
  - MIT
67
67
  metadata:
68
68
  homepage_uri: https://pagepixels.com
69
- source_code_uri: https://github.com/PagePixels/screenshots_pagepixels-ruby
70
- changelog_uri: https://github.com/PagePixels/screenshots_pagepixels-ruby/CHANGELOG.md
69
+ source_code_uri: https://github.com/PagePixels/screenshots-pagepixels-ruby
70
+ changelog_uri: https://github.com/PagePixels/screenshots-pagepixels-ruby/CHANGELOG.md
71
71
  post_install_message:
72
72
  rdoc_options: []
73
73
  require_paths: