crawlora-appstore 0.1.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 +7 -0
- data/CHANGELOG.md +5 -0
- data/LICENSE +21 -0
- data/README.md +33 -0
- data/lib/crawlora/appstore/client.rb +256 -0
- data/lib/crawlora/appstore/version.rb +5 -0
- data/lib/crawlora/appstore.rb +2 -0
- metadata +51 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: e7d3fe485ab21609cc1a35634e7815f6188fc8ea64e7394eea7bdef3333a6633
|
|
4
|
+
data.tar.gz: d90a86437e5863536d0df9fed04176845568acec4e989b9e541d8b438d8b7134
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 62ffc911095c150558ffd8f801249bf422def94dfa350896eafd68462c4e28a12671eb88f8f72cbcc84fb201ff46524bb9f4fba05eabd22f1fa6c06c6c26af52
|
|
7
|
+
data.tar.gz: 371db3c596de5af63eebdb96f49da62d9924ae971f149c87d6d25e1c93a05974ee9676727285c28de54a4dbdaf7193b4762cf6dabb7361bd7e6c42bc7a534948
|
data/CHANGELOG.md
ADDED
data/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Crawlora
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
data/README.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Crawlora App Store Ruby client
|
|
2
|
+
|
|
3
|
+
This gem calls the Crawlora hosted API at `https://api.crawlora.net/api/v1`. It does not call or scrape App Store directly. Requests require your Crawlora API key and use your account's service plan.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```ruby
|
|
8
|
+
gem "crawlora-appstore"
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Create an account at [crawlora.net](https://crawlora.net/signup?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=appstore-ruby-signup), open the [Crawlora console](https://crawlora.net/app?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=appstore-ruby-console) to get an API key, and set `CRAWLORA_API_KEY` before running the client:
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require "json"
|
|
15
|
+
require "crawlora/appstore"
|
|
16
|
+
|
|
17
|
+
client = Crawlora::Appstore::Client.new
|
|
18
|
+
result = client.request("appstore-search", JSON.parse("{\"term\": \"sample\"}"))
|
|
19
|
+
puts result
|
|
20
|
+
client.close
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Use an operation-specific method for normal calls. `request(operation_id, params = {}, response_type: :auto)` is available for every operation. `response_type: :text` returns raw response text. This gem includes 15 API operations.
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
client = Crawlora::Appstore::Client.new(api_key: ENV.fetch("CRAWLORA_API_KEY"), timeout: 30)
|
|
27
|
+
# client.<operation_method>(<endpoint parameters>)
|
|
28
|
+
client.close
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Client options include `api_key`, `base_url`, and `timeout`. Ruby stdlib provides the HTTP and JSON support.
|
|
32
|
+
|
|
33
|
+
See [Crawlora](https://crawlora.net/?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=appstore-ruby-homepage), the [API documentation](https://crawlora.net/docs?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=appstore-ruby-api-docs), and [the package repository](https://github.com/Crawlora-org/crawlora-appstore) for account setup, the API operation reference, and release history.
|
|
@@ -0,0 +1,256 @@
|
|
|
1
|
+
require "json"
|
|
2
|
+
require "net/http"
|
|
3
|
+
require "uri"
|
|
4
|
+
|
|
5
|
+
module Crawlora
|
|
6
|
+
module Appstore
|
|
7
|
+
module Errors
|
|
8
|
+
class Error < StandardError
|
|
9
|
+
attr_reader :status, :operation_id, :body
|
|
10
|
+
|
|
11
|
+
def initialize(message, status: nil, operation_id: nil, body: nil)
|
|
12
|
+
super(message)
|
|
13
|
+
@status, @operation_id, @body = status, operation_id, body
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
class ClientError < Error; end
|
|
17
|
+
class ServerError < Error; end
|
|
18
|
+
class NetworkError < Error; end
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
OPERATIONS = JSON.parse(<<~'JSON').freeze
|
|
22
|
+
{"appstore-app": {"bodyParam": null, "bodyRequired": false, "id": "appstore-app", "method": "GET", "params": [{"description": "App Store numeric track ID (digits only)", "in": "query", "name": "id", "type": "string", "x-example": "553834731"}, {"description": "App Store bundle ID", "in": "query", "name": "app_id", "type": "string", "x-example": "com.midasplayer.apps.candycrushsaga"}, {"description": "Two-letter storefront country code", "in": "query", "name": "country", "type": "string", "x-example": "us"}, {"description": "Result language tag", "in": "query", "name": "lang", "type": "string", "x-example": "en-us"}, {"default": false, "description": "Include ratings histogram", "in": "query", "name": "ratings", "type": "boolean"}, {"default": false, "description": "Include the full device-platform compatibility list (adds one extra upstream fetch)", "in": "query", "name": "platforms", "type": "boolean"}], "path": "/appstore/app", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "id", "type": "string"}, {"in": "query", "name": "app_id", "type": "string"}, {"in": "query", "name": "country", "type": "string"}, {"in": "query", "name": "lang", "type": "string"}, {"in": "query", "name": "ratings", "type": "boolean"}, {"in": "query", "name": "platforms", "type": "boolean"}], "security": ["ApiKeyAuth"]}, "appstore-categories": {"bodyParam": null, "bodyRequired": false, "id": "appstore-categories", "method": "GET", "params": [], "path": "/appstore/categories", "pathParams": [], "produces": ["application/json"], "queryParams": [], "security": ["ApiKeyAuth"]}, "appstore-collection": {"bodyParam": null, "bodyRequired": false, "id": "appstore-collection", "method": "GET", "params": [{"description": "Apple device catalog", "enum": ["iphone", "ipad", "mac", "vision", "watch", "tv"], "in": "query", "name": "platform", "required": true, "type": "string", "x-example": "iphone"}, {"description": "Room ID or EDS UUID collection ID from appstore_collections", "in": "query", "name": "collection_id", "required": true, "type": "string", "x-example": "6757461219"}, {"description": "Two-letter storefront country code", "in": "query", "name": "country", "type": "string", "x-example": "us"}, {"description": "Result language tag", "in": "query", "name": "lang", "type": "string", "x-example": "en-us"}], "path": "/appstore/collection", "pathParams": [], "produces": ["application/json"], "queryParams": [{"enum": ["iphone", "ipad", "mac", "vision", "watch", "tv"], "in": "query", "name": "platform", "required": true, "type": "string"}, {"in": "query", "name": "collection_id", "required": true, "type": "string"}, {"in": "query", "name": "country", "type": "string"}, {"in": "query", "name": "lang", "type": "string"}], "security": ["ApiKeyAuth"]}, "appstore-collections": {"bodyParam": null, "bodyRequired": false, "id": "appstore-collections", "method": "GET", "params": [{"description": "Apple device catalog", "enum": ["iphone", "ipad", "mac", "vision", "watch", "tv"], "in": "query", "name": "platform", "required": true, "type": "string", "x-example": "iphone"}, {"description": "Two-letter storefront country code", "in": "query", "name": "country", "type": "string", "x-example": "us"}, {"description": "Result language tag", "in": "query", "name": "lang", "type": "string", "x-example": "en-us"}], "path": "/appstore/collections", "pathParams": [], "produces": ["application/json"], "queryParams": [{"enum": ["iphone", "ipad", "mac", "vision", "watch", "tv"], "in": "query", "name": "platform", "required": true, "type": "string"}, {"in": "query", "name": "country", "type": "string"}, {"in": "query", "name": "lang", "type": "string"}], "security": ["ApiKeyAuth"]}, "appstore-developer": {"bodyParam": null, "bodyRequired": false, "id": "appstore-developer", "method": "GET", "params": [{"description": "Developer artist ID", "in": "path", "name": "dev_id", "required": true, "type": "string", "x-example": "284882218"}, {"description": "Two-letter storefront country code", "in": "query", "name": "country", "type": "string", "x-example": "us"}, {"description": "Result language tag", "in": "query", "name": "lang", "type": "string", "x-example": "en-us"}], "path": "/appstore/developer/{dev_id}", "pathParams": ["dev_id"], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "country", "type": "string"}, {"in": "query", "name": "lang", "type": "string"}], "security": ["ApiKeyAuth"]}, "appstore-editorial": {"bodyParam": null, "bodyRequired": false, "id": "appstore-editorial", "method": "GET", "params": [{"description": "Apple device catalog", "enum": ["iphone", "ipad", "mac", "vision", "watch", "tv"], "in": "query", "name": "device", "required": true, "type": "string", "x-example": "iphone"}, {"default": "main", "description": "Editorial section within the device", "enum": ["main", "arcade"], "in": "query", "name": "section", "type": "string"}, {"description": "Two-letter storefront country code", "in": "query", "name": "country", "type": "string", "x-example": "us"}, {"description": "Result language tag", "in": "query", "name": "lang", "type": "string", "x-example": "en-us"}], "path": "/appstore/editorial", "pathParams": [], "produces": ["application/json"], "queryParams": [{"enum": ["iphone", "ipad", "mac", "vision", "watch", "tv"], "in": "query", "name": "device", "required": true, "type": "string"}, {"enum": ["main", "arcade"], "in": "query", "name": "section", "type": "string"}, {"in": "query", "name": "country", "type": "string"}, {"in": "query", "name": "lang", "type": "string"}], "security": ["ApiKeyAuth"]}, "appstore-editorial-category": {"bodyParam": null, "bodyRequired": false, "id": "appstore-editorial-category", "method": "GET", "params": [{"description": "Apple device catalog", "enum": ["iphone", "ipad", "mac", "vision", "watch", "tv"], "in": "query", "name": "device", "required": true, "type": "string", "x-example": "iphone"}, {"description": "Numeric App Store editorial page ID, discovered from appstore_editorial (same device)", "in": "query", "name": "category_id", "required": true, "type": "string", "x-example": "6503709728"}, {"description": "Two-letter storefront country code", "in": "query", "name": "country", "type": "string", "x-example": "us"}, {"description": "Result language tag", "in": "query", "name": "lang", "type": "string", "x-example": "en-us"}], "path": "/appstore/editorial/category", "pathParams": [], "produces": ["application/json"], "queryParams": [{"enum": ["iphone", "ipad", "mac", "vision", "watch", "tv"], "in": "query", "name": "device", "required": true, "type": "string"}, {"in": "query", "name": "category_id", "required": true, "type": "string"}, {"in": "query", "name": "country", "type": "string"}, {"in": "query", "name": "lang", "type": "string"}], "security": ["ApiKeyAuth"]}, "appstore-list": {"bodyParam": null, "bodyRequired": false, "id": "appstore-list", "method": "GET", "params": [{"description": "Chart collection slug, see description for the full enum", "in": "query", "name": "collection", "type": "string", "x-example": "topfreeapplications"}, {"description": "Numeric App Store category ID, see description for the full enum; e.g. 6014 = Games, 7012 = Games/Puzzle", "in": "query", "name": "category", "type": "integer", "x-example": 6014}, {"description": "Two-letter storefront country code", "in": "query", "name": "country", "type": "string", "x-example": "us"}, {"description": "Result language tag", "in": "query", "name": "lang", "type": "string", "x-example": "en-us"}, {"description": "Number of apps to return", "in": "query", "name": "num", "type": "integer", "x-example": 50}, {"default": false, "description": "Expand each app via lookup API", "in": "query", "name": "full_detail", "type": "boolean"}], "path": "/appstore/list", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "collection", "type": "string"}, {"in": "query", "name": "category", "type": "integer"}, {"in": "query", "name": "country", "type": "string"}, {"in": "query", "name": "lang", "type": "string"}, {"in": "query", "name": "num", "type": "integer"}, {"in": "query", "name": "full_detail", "type": "boolean"}], "security": ["ApiKeyAuth"]}, "appstore-privacy": {"bodyParam": null, "bodyRequired": false, "id": "appstore-privacy", "method": "GET", "params": [{"description": "App Store numeric track ID (digits only)", "in": "path", "name": "id", "required": true, "type": "string", "x-example": "324684580"}, {"description": "Two-letter storefront country code", "in": "query", "name": "country", "type": "string", "x-example": "us"}, {"description": "Result language tag", "in": "query", "name": "lang", "type": "string", "x-example": "en-us"}], "path": "/appstore/privacy/{id}", "pathParams": ["id"], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "country", "type": "string"}, {"in": "query", "name": "lang", "type": "string"}], "security": ["ApiKeyAuth"]}, "appstore-ratings": {"bodyParam": null, "bodyRequired": false, "id": "appstore-ratings", "method": "GET", "params": [{"description": "App Store numeric track ID (digits only)", "in": "query", "name": "id", "type": "string", "x-example": "553834731"}, {"description": "App Store bundle ID", "in": "query", "name": "app_id", "type": "string", "x-example": "com.midasplayer.apps.candycrushsaga"}, {"description": "Two-letter storefront country code", "in": "query", "name": "country", "type": "string", "x-example": "us"}, {"description": "Result language tag", "in": "query", "name": "lang", "type": "string", "x-example": "en-us"}], "path": "/appstore/ratings", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "id", "type": "string"}, {"in": "query", "name": "app_id", "type": "string"}, {"in": "query", "name": "country", "type": "string"}, {"in": "query", "name": "lang", "type": "string"}], "security": ["ApiKeyAuth"]}, "appstore-reviews": {"bodyParam": null, "bodyRequired": false, "id": "appstore-reviews", "method": "GET", "params": [{"description": "App Store numeric track ID (digits only)", "in": "query", "name": "id", "type": "string", "x-example": "553834731"}, {"description": "App Store bundle ID", "in": "query", "name": "app_id", "type": "string", "x-example": "com.midasplayer.apps.candycrushsaga"}, {"description": "Two-letter storefront country code", "in": "query", "name": "country", "type": "string", "x-example": "us"}, {"description": "Review page number (1-10)", "in": "query", "name": "page", "type": "integer", "x-example": 1}, {"default": "mostRecent", "description": "Sort order", "enum": ["mostRecent", "mostHelpful"], "in": "query", "name": "sort", "type": "string"}, {"description": "Result language tag", "in": "query", "name": "lang", "type": "string", "x-example": "en-us"}], "path": "/appstore/reviews", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "id", "type": "string"}, {"in": "query", "name": "app_id", "type": "string"}, {"in": "query", "name": "country", "type": "string"}, {"in": "query", "name": "page", "type": "integer"}, {"enum": ["mostRecent", "mostHelpful"], "in": "query", "name": "sort", "type": "string"}, {"in": "query", "name": "lang", "type": "string"}], "security": ["ApiKeyAuth"]}, "appstore-search": {"bodyParam": null, "bodyRequired": false, "id": "appstore-search", "method": "GET", "params": [{"description": "Search term", "in": "query", "name": "term", "required": true, "type": "string", "x-example": "panda"}, {"description": "Number of apps per page", "in": "query", "name": "num", "type": "integer", "x-example": 50}, {"description": "Search page number (1-based)", "in": "query", "name": "page", "type": "integer", "x-example": 1}, {"description": "Two-letter storefront country code", "in": "query", "name": "country", "type": "string", "x-example": "us"}, {"description": "Result language tag", "in": "query", "name": "lang", "type": "string", "x-example": "en-us"}, {"default": false, "description": "Return only app IDs", "in": "query", "name": "ids_only", "type": "boolean"}, {"default": "phone", "description": "App Store catalog to search: phone, pad, mac", "enum": ["phone", "pad", "mac"], "in": "query", "name": "platform", "type": "string"}], "path": "/appstore/search", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "term", "required": true, "type": "string"}, {"in": "query", "name": "num", "type": "integer"}, {"in": "query", "name": "page", "type": "integer"}, {"in": "query", "name": "country", "type": "string"}, {"in": "query", "name": "lang", "type": "string"}, {"in": "query", "name": "ids_only", "type": "boolean"}, {"enum": ["phone", "pad", "mac"], "in": "query", "name": "platform", "type": "string"}], "security": ["ApiKeyAuth"]}, "appstore-similar": {"bodyParam": null, "bodyRequired": false, "id": "appstore-similar", "method": "GET", "params": [{"description": "App Store numeric track ID (digits only)", "in": "query", "name": "id", "type": "string", "x-example": "553834731"}, {"description": "App Store bundle ID", "in": "query", "name": "app_id", "type": "string", "x-example": "com.midasplayer.apps.candycrushsaga"}, {"description": "Two-letter storefront country code", "in": "query", "name": "country", "type": "string", "x-example": "us"}, {"description": "Result language tag", "in": "query", "name": "lang", "type": "string", "x-example": "en-us"}], "path": "/appstore/similar", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "id", "type": "string"}, {"in": "query", "name": "app_id", "type": "string"}, {"in": "query", "name": "country", "type": "string"}, {"in": "query", "name": "lang", "type": "string"}], "security": ["ApiKeyAuth"]}, "appstore-suggest": {"bodyParam": null, "bodyRequired": false, "id": "appstore-suggest", "method": "GET", "params": [{"description": "Partial search term", "in": "path", "name": "term", "required": true, "type": "string", "x-example": "panda"}, {"description": "Two-letter storefront country code", "in": "query", "name": "country", "type": "string", "x-example": "us"}], "path": "/appstore/suggest/{term}", "pathParams": ["term"], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "country", "type": "string"}], "security": ["ApiKeyAuth"]}, "appstore-version-history": {"bodyParam": null, "bodyRequired": false, "id": "appstore-version-history", "method": "GET", "params": [{"description": "App Store numeric track ID (digits only)", "in": "path", "name": "id", "required": true, "type": "string", "x-example": "553834731"}, {"description": "Two-letter storefront country code", "in": "query", "name": "country", "type": "string", "x-example": "us"}, {"description": "Result language tag", "in": "query", "name": "lang", "type": "string", "x-example": "en-us"}], "path": "/appstore/version-history/{id}", "pathParams": ["id"], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "country", "type": "string"}, {"in": "query", "name": "lang", "type": "string"}], "security": ["ApiKeyAuth"]}}
|
|
23
|
+
JSON
|
|
24
|
+
OPERATION_IDS = JSON.parse(<<~'JSON').freeze
|
|
25
|
+
["appstore-app", "appstore-categories", "appstore-collection", "appstore-collections", "appstore-developer", "appstore-editorial", "appstore-editorial-category", "appstore-list", "appstore-privacy", "appstore-ratings", "appstore-reviews", "appstore-search", "appstore-similar", "appstore-suggest", "appstore-version-history"]
|
|
26
|
+
JSON
|
|
27
|
+
OPERATION_COUNT = OPERATION_IDS.length
|
|
28
|
+
|
|
29
|
+
class Client
|
|
30
|
+
attr_reader :base_url
|
|
31
|
+
|
|
32
|
+
def initialize(api_key: ENV["CRAWLORA_API_KEY"], base_url: "https://api.crawlora.net/api/v1", timeout: 30, user_agent: "crawlora-appstore-ruby/0.1.0", transport: nil)
|
|
33
|
+
@api_key = api_key
|
|
34
|
+
@base_url = base_url.to_s.sub(%r{/+$}, "")
|
|
35
|
+
@timeout = Float(timeout)
|
|
36
|
+
@user_agent = user_agent
|
|
37
|
+
@transport = transport
|
|
38
|
+
@closed = false
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
def request(operation_id, params = {}, response_type: :auto)
|
|
42
|
+
raise Errors::ClientError, "client is closed" if @closed
|
|
43
|
+
operation_id = operation_id.to_s
|
|
44
|
+
operation = OPERATIONS[operation_id]
|
|
45
|
+
raise Errors::ClientError.new("unknown operation: #{operation_id}", operation_id: operation_id) unless operation
|
|
46
|
+
raise Errors::ClientError.new("Crawlora API key is required", operation_id: operation_id) if @api_key.nil? || @api_key.to_s.empty?
|
|
47
|
+
normalized = params.each_with_object({}) { |(key, value), out| out[key.to_s] = value }
|
|
48
|
+
payload = request_body(operation, normalized)
|
|
49
|
+
url = build_url(operation, normalized)
|
|
50
|
+
uri = URI.parse(url)
|
|
51
|
+
request = operation["method"] == "POST" ? Net::HTTP::Post.new(uri) : Net::HTTP::Get.new(uri)
|
|
52
|
+
unless payload.nil?
|
|
53
|
+
request.body = payload
|
|
54
|
+
request["Content-Type"] = "application/json"
|
|
55
|
+
end
|
|
56
|
+
request["x-api-key"] = @api_key
|
|
57
|
+
request["User-Agent"] = @user_agent
|
|
58
|
+
request["Accept"] = operation["produces"].include?("text/plain") ? "application/json, text/plain" : "application/json"
|
|
59
|
+
begin
|
|
60
|
+
if @transport
|
|
61
|
+
response = if operation["method"] == "POST"
|
|
62
|
+
@transport.call(url, request.to_hash, @timeout, "POST", payload)
|
|
63
|
+
else
|
|
64
|
+
@transport.call(url, request.to_hash, @timeout)
|
|
65
|
+
end
|
|
66
|
+
status = Integer(response.fetch(:status) { response.fetch("status") })
|
|
67
|
+
body = response.fetch(:body) { response.fetch("body", "") }
|
|
68
|
+
headers = response.fetch(:headers) { response.fetch("headers", {}) }
|
|
69
|
+
content_type = headers["content-type"] || headers["Content-Type"]
|
|
70
|
+
else
|
|
71
|
+
http = Net::HTTP.new(uri.host, uri.port)
|
|
72
|
+
http.use_ssl = uri.scheme == "https"
|
|
73
|
+
http.open_timeout = @timeout
|
|
74
|
+
http.read_timeout = @timeout
|
|
75
|
+
response = http.start { |connection| connection.request(request) }
|
|
76
|
+
status = response.code.to_i
|
|
77
|
+
body = response.body
|
|
78
|
+
content_type = response["content-type"]
|
|
79
|
+
end
|
|
80
|
+
rescue Timeout::Error, SocketError, SystemCallError, IOError, EOFError, Net::HTTPBadResponse, Net::ProtocolError, OpenSSL::SSL::SSLError => error
|
|
81
|
+
raise Errors::NetworkError.new("Crawlora request failed: #{error.message}", operation_id: operation_id)
|
|
82
|
+
end
|
|
83
|
+
unless status >= 200 && status < 300
|
|
84
|
+
klass = status >= 500 ? Errors::ServerError : Errors::ClientError
|
|
85
|
+
raise klass.new("Crawlora returned HTTP #{status}", status: status, operation_id: operation_id, body: body)
|
|
86
|
+
end
|
|
87
|
+
parse_response(body, content_type, operation, normalized, response_type)
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
def close
|
|
91
|
+
@closed = true
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
def closed?
|
|
95
|
+
@closed
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
def with
|
|
99
|
+
return self unless block_given?
|
|
100
|
+
yield self
|
|
101
|
+
ensure
|
|
102
|
+
close if block_given?
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
def self.operation_count
|
|
106
|
+
OPERATION_COUNT
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
def self.operation_ids
|
|
110
|
+
OPERATION_IDS
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
def self.operations
|
|
114
|
+
OPERATIONS
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
define_method('app') do |**params|
|
|
118
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
119
|
+
request('appstore-app', params, response_type: response_type)
|
|
120
|
+
end
|
|
121
|
+
define_method('categories') do |**params|
|
|
122
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
123
|
+
request('appstore-categories', params, response_type: response_type)
|
|
124
|
+
end
|
|
125
|
+
define_method('collection') do |**params|
|
|
126
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
127
|
+
request('appstore-collection', params, response_type: response_type)
|
|
128
|
+
end
|
|
129
|
+
define_method('collections') do |**params|
|
|
130
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
131
|
+
request('appstore-collections', params, response_type: response_type)
|
|
132
|
+
end
|
|
133
|
+
define_method('developer') do |**params|
|
|
134
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
135
|
+
request('appstore-developer', params, response_type: response_type)
|
|
136
|
+
end
|
|
137
|
+
define_method('editorial') do |**params|
|
|
138
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
139
|
+
request('appstore-editorial', params, response_type: response_type)
|
|
140
|
+
end
|
|
141
|
+
define_method('editorial_category') do |**params|
|
|
142
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
143
|
+
request('appstore-editorial-category', params, response_type: response_type)
|
|
144
|
+
end
|
|
145
|
+
define_method('list') do |**params|
|
|
146
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
147
|
+
request('appstore-list', params, response_type: response_type)
|
|
148
|
+
end
|
|
149
|
+
define_method('privacy') do |**params|
|
|
150
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
151
|
+
request('appstore-privacy', params, response_type: response_type)
|
|
152
|
+
end
|
|
153
|
+
define_method('ratings') do |**params|
|
|
154
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
155
|
+
request('appstore-ratings', params, response_type: response_type)
|
|
156
|
+
end
|
|
157
|
+
define_method('reviews') do |**params|
|
|
158
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
159
|
+
request('appstore-reviews', params, response_type: response_type)
|
|
160
|
+
end
|
|
161
|
+
define_method('search') do |**params|
|
|
162
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
163
|
+
request('appstore-search', params, response_type: response_type)
|
|
164
|
+
end
|
|
165
|
+
define_method('similar') do |**params|
|
|
166
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
167
|
+
request('appstore-similar', params, response_type: response_type)
|
|
168
|
+
end
|
|
169
|
+
define_method('suggest') do |**params|
|
|
170
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
171
|
+
request('appstore-suggest', params, response_type: response_type)
|
|
172
|
+
end
|
|
173
|
+
define_method('version_history') do |**params|
|
|
174
|
+
response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
|
|
175
|
+
request('appstore-version-history', params, response_type: response_type)
|
|
176
|
+
end
|
|
177
|
+
|
|
178
|
+
private
|
|
179
|
+
|
|
180
|
+
# POST operations take their JSON body under the body parameter name or "body".
|
|
181
|
+
def request_body(operation, params)
|
|
182
|
+
name = operation["bodyParam"]
|
|
183
|
+
return nil if name.nil?
|
|
184
|
+
value = params.key?(name) ? params[name] : params["body"]
|
|
185
|
+
if value.nil?
|
|
186
|
+
raise Errors::ClientError.new("missing request body: #{name}", operation_id: operation["id"]) if operation["bodyRequired"]
|
|
187
|
+
return nil
|
|
188
|
+
end
|
|
189
|
+
value.is_a?(String) ? value : JSON.generate(value)
|
|
190
|
+
end
|
|
191
|
+
|
|
192
|
+
def build_url(operation, params)
|
|
193
|
+
known = operation["params"].map { |param| param["name"] }
|
|
194
|
+
known << "body" if operation["bodyParam"]
|
|
195
|
+
unknown = params.keys - known
|
|
196
|
+
raise Errors::ClientError.new("unknown parameters: #{unknown.join(', ')}", operation_id: operation["id"]) unless unknown.empty?
|
|
197
|
+
path = operation["path"].dup
|
|
198
|
+
operation["params"].select { |param| param["in"] == "path" }.each do |param|
|
|
199
|
+
value = params[param["name"]]
|
|
200
|
+
raise Errors::ClientError.new("missing path parameter: #{param['name']}", operation_id: operation["id"]) if value.nil?
|
|
201
|
+
path.sub!("{" + param["name"] + "}", percent_encode(value.to_s))
|
|
202
|
+
end
|
|
203
|
+
pairs = []
|
|
204
|
+
operation["queryParams"].each do |param|
|
|
205
|
+
name = param["name"]
|
|
206
|
+
value = params.key?(name) ? params[name] : param["default"]
|
|
207
|
+
if value.nil?
|
|
208
|
+
raise Errors::ClientError.new("missing query parameter: #{name}", operation_id: operation["id"]) if param["required"]
|
|
209
|
+
next
|
|
210
|
+
end
|
|
211
|
+
enum_values = param["enum"] || (param["items"] && param["items"]["enum"])
|
|
212
|
+
if enum_values && !(value.is_a?(Array) ? value : [value]).all? { |item| enum_values.map(&:to_s).include?(item.to_s) }
|
|
213
|
+
raise Errors::ClientError.new("invalid value for #{name}", operation_id: operation["id"])
|
|
214
|
+
end
|
|
215
|
+
if value.is_a?(Array)
|
|
216
|
+
format = param["collectionFormat"] || "csv"
|
|
217
|
+
if format == "multi"
|
|
218
|
+
value.each { |item| pairs << [name, scalar(item)] }
|
|
219
|
+
else
|
|
220
|
+
separator = {"csv" => ",", "ssv" => " ", "tsv" => "\t", "pipes" => "|"}[format] || ","
|
|
221
|
+
pairs << [name, value.map { |item| scalar(item) }.join(separator)]
|
|
222
|
+
end
|
|
223
|
+
else
|
|
224
|
+
pairs << [name, scalar(value)]
|
|
225
|
+
end
|
|
226
|
+
end
|
|
227
|
+
query = pairs.map { |name, value| "#{percent_encode(name)}=#{percent_encode(value)}" }.join("&")
|
|
228
|
+
@base_url + path + (query.empty? ? "" : "?" + query)
|
|
229
|
+
end
|
|
230
|
+
|
|
231
|
+
def scalar(value)
|
|
232
|
+
value == true ? "true" : (value == false ? "false" : value.to_s)
|
|
233
|
+
end
|
|
234
|
+
|
|
235
|
+
def percent_encode(value)
|
|
236
|
+
URI::DEFAULT_PARSER.escape(value.to_s, /[^A-Za-z0-9\-._~]/)
|
|
237
|
+
end
|
|
238
|
+
|
|
239
|
+
def parse_response(body, content_type, operation, params, response_type)
|
|
240
|
+
type = response_type.to_s
|
|
241
|
+
raise Errors::ClientError.new("response_type must be auto, json, or text", operation_id: operation["id"]) unless %w[auto json text].include?(type)
|
|
242
|
+
format = operation["params"].find { |param| param["name"] == "format" }
|
|
243
|
+
text_formats = format && format["enum"] ? format["enum"].reject { |value| %w[json application/json].include?(value.to_s.downcase) } : []
|
|
244
|
+
raw_format = params["format"] && text_formats.include?(params["format"].to_s)
|
|
245
|
+
json_format = format && format["enum"] && format["enum"].any? { |value| %w[json application/json].include?(value.to_s.downcase) } && %w[json application/json].include?(params["format"].to_s.downcase)
|
|
246
|
+
is_json = json_format || content_type.to_s.downcase.include?("json") || operation["produces"] == ["application/json"]
|
|
247
|
+
return body if type == "text" || raw_format || (type == "auto" && !is_json)
|
|
248
|
+
JSON.parse(body)
|
|
249
|
+
rescue JSON::ParserError => error
|
|
250
|
+
raise Errors::Error.new("invalid JSON response from Crawlora: #{error.message}", operation_id: operation["id"], body: body)
|
|
251
|
+
end
|
|
252
|
+
|
|
253
|
+
public
|
|
254
|
+
end
|
|
255
|
+
end
|
|
256
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: crawlora-appstore
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.1.0
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Crawlora
|
|
8
|
+
autorequire:
|
|
9
|
+
bindir: bin
|
|
10
|
+
cert_chain: []
|
|
11
|
+
date: 2026-10-11 00:00:00.000000000 Z
|
|
12
|
+
dependencies: []
|
|
13
|
+
description: Credential-free App Store API access through Crawlora's hosted service.
|
|
14
|
+
email:
|
|
15
|
+
executables: []
|
|
16
|
+
extensions: []
|
|
17
|
+
extra_rdoc_files: []
|
|
18
|
+
files:
|
|
19
|
+
- CHANGELOG.md
|
|
20
|
+
- LICENSE
|
|
21
|
+
- README.md
|
|
22
|
+
- lib/crawlora/appstore.rb
|
|
23
|
+
- lib/crawlora/appstore/client.rb
|
|
24
|
+
- lib/crawlora/appstore/version.rb
|
|
25
|
+
homepage: https://crawlora.net/?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=appstore-ruby-homepage
|
|
26
|
+
licenses:
|
|
27
|
+
- MIT
|
|
28
|
+
metadata:
|
|
29
|
+
source_code_uri: https://github.com/Crawlora-org/crawlora-appstore
|
|
30
|
+
documentation_uri: https://github.com/Crawlora-org/crawlora-appstore/blob/main/ruby/README.md
|
|
31
|
+
rubygems_mfa_required: 'true'
|
|
32
|
+
post_install_message:
|
|
33
|
+
rdoc_options: []
|
|
34
|
+
require_paths:
|
|
35
|
+
- lib
|
|
36
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
37
|
+
requirements:
|
|
38
|
+
- - ">="
|
|
39
|
+
- !ruby/object:Gem::Version
|
|
40
|
+
version: '2.6'
|
|
41
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
42
|
+
requirements:
|
|
43
|
+
- - ">="
|
|
44
|
+
- !ruby/object:Gem::Version
|
|
45
|
+
version: '0'
|
|
46
|
+
requirements: []
|
|
47
|
+
rubygems_version: 3.4.19
|
|
48
|
+
signing_key:
|
|
49
|
+
specification_version: 4
|
|
50
|
+
summary: App Store client for the Crawlora hosted API
|
|
51
|
+
test_files: []
|