ghub 0.2.0 → 0.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (11) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/README.adoc +21 -13
  4. data/ghub.gemspec +7 -7
  5. data/lib/ghub/endpoints/pulls/models/show.rb +4 -2
  6. data/lib/ghub/endpoints/pulls/responses/show.rb +7 -7
  7. data/lib/ghub/endpoints/repositories/actions/create.rb +10 -10
  8. data/lib/ghub/endpoints/repositories/actions/patch.rb +10 -10
  9. data.tar.gz.sig +0 -0
  10. metadata +14 -14
  11. metadata.gz.sig +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 11b90fd0f3b4897a32379d148a4e1167d8511d82f917e92577aefef4f3fa4665
4
- data.tar.gz: b4942bf7cf3226735c8c1153a57414a7458edb5ef0532c9c3ac2f20a927dbb0d
3
+ metadata.gz: 86ed95e15942ee666a5e4094d1d5d7e77daed1886228491ba556cefa20cb9802
4
+ data.tar.gz: 555ba2c32b311df27c11965749a1caece8ef1e55561c72941524fdec862b4fef
5
5
  SHA512:
6
- metadata.gz: ab7ac345787ab1fced4b9a6887ac97804e87cd5f8a0bde024d54d3fe8a88f95f60e70cca533d6d2addede9ecfd9b9ea352908b3494ddce9f9f5ec0ad2263f4c1
7
- data.tar.gz: e926afa6dbc0babdf0fc918d3d0c72922d7b495c845a0154d15d20e25f361c49b73dee7ac5b5cb6c673bc98846a6f4b2bbef44ffb686ce2785837906efb01a54
6
+ metadata.gz: 463c48c1e6a9407ab559bcc1a585affd67afc1f1f97d5db28c55e5cd56815ac6b8b402d14f0cd3b3c0424616ad4eb4cd5d7c085578c2e2a754dd99810f4cc14b
7
+ data.tar.gz: 36b9c113333d009fd8c71319bda53c1ba41bfb155f6d5f2bb6b7777b47de0c7a245ee69b6b219a904ff332bf1bb78c2fd55dc2ea878b3aca8ee32157dff975b0
checksums.yaml.gz.sig CHANGED
Binary file
data/README.adoc CHANGED
@@ -126,19 +126,27 @@ The following documents how to interact with repositories:
126
126
 
127
127
  [source,ruby]
128
128
  ----
129
- client.repositories.index "<owner>", "<repository>"
130
- client.repositories.show "<owner>", "<repository>"
131
-
132
- # For a user.
133
- # Example: client.repositories.create :users, {name: "ghub-test", private: true}
134
- client.repositories.create :users, <attributes>
135
-
136
- # For an organization.
137
- # Example: client.repositories.create :orgs, {name: "ghub-test", private: true}, owner: "acme"
138
- client.repositories.create :orgs, <attributes>, owner: "<organization>"
139
-
140
- client.repositories.patch "<owner>", {description: "For test only."}
141
- client.repositories.destroy "<owner>", <id>
129
+ # Index (user and organization)
130
+ # Format: client.repositories.index :<kind>, "<owner>"
131
+ client.repositories.index :users, "doe"
132
+ client.repositories.index :orgs, "acme"
133
+
134
+ # Show (user or organization)
135
+ # Format: client.repositories.show "<owner>", "<repository>"
136
+ client.repositories.show "acme", "ghub-test"
137
+
138
+ # Create (user and organization)
139
+ # Format: client.repositories.create :<kind>, <body>
140
+ client.repositories.create :users, {name: "ghub-test", private: true}
141
+ client.repositories.create :orgs, {name: "ghub-test", private: true}, owner: "acme"
142
+
143
+ # Patch (user or organization)
144
+ # Format: client.repositories.patch "<owner>", "<repository>", <body>
145
+ client.repositories.patch "acme", "ghub-test", {description: "For test only."}
146
+
147
+ # Destroy (user or organization)
148
+ # Format: client.repositories.destroy "<owner>", "<repository>"
149
+ client.repositories.destroy "acme", "ghub-test"
142
150
  ----
143
151
 
144
152
  GitHub's API design for repositories is awkward and you can see this infect the Object API, especially when creating a repository. Use `:users` or `:orgs` (can be strings) to distinguish between the two types of repository creation. The only stipulation for organization creation is that you must supply the organization name. This was done so you could use the same Object API for both.
data/ghub.gemspec CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  Gem::Specification.new do |spec|
4
4
  spec.name = "ghub"
5
- spec.version = "0.2.0"
5
+ spec.version = "0.4.0"
6
6
  spec.authors = ["Brooke Kuhlmann"]
7
7
  spec.email = ["brooke@alchemists.io"]
8
8
  spec.homepage = "https://www.alchemists.io/projects/ghub"
@@ -22,14 +22,14 @@ Gem::Specification.new do |spec|
22
22
  spec.signing_key = Gem.default_key_path
23
23
  spec.cert_chain = [Gem.default_cert_path]
24
24
 
25
- spec.required_ruby_version = "~> 3.1"
25
+ spec.required_ruby_version = "~> 3.2"
26
26
  spec.add_dependency "dry-container", "~> 0.11"
27
- spec.add_dependency "dry-monads", "~> 1.5"
28
- spec.add_dependency "dry-schema", "~> 1.11"
27
+ spec.add_dependency "dry-monads", "~> 1.6"
28
+ spec.add_dependency "dry-schema", "~> 1.13"
29
29
  spec.add_dependency "http", "~> 5.1"
30
- spec.add_dependency "infusible", "~> 0.2"
31
- spec.add_dependency "refinements", "~> 9.7"
32
- spec.add_dependency "transactable", "~> 0.3"
30
+ spec.add_dependency "infusible", "~> 1.0"
31
+ spec.add_dependency "refinements", "~> 10.0"
32
+ spec.add_dependency "transactable", "~> 0.4"
33
33
  spec.add_dependency "zeitwerk", "~> 2.6"
34
34
 
35
35
  spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
data/lib/ghub/endpoints/pulls/models/show.rb CHANGED
@@ -32,7 +32,7 @@ module Ghub
32
32
  :labels,
33
33
  :locked,
34
34
  :maintainer_can_modify,
35
- :mergable,
35
+ :mergeable,
36
36
  :merge_commit_sha,
37
37
  :mergeable_state,
38
38
  :merged,
@@ -59,9 +59,11 @@ module Ghub
59
59
  include Resultable
60
60
 
61
61
  def self.for attributes
62
+ assignee = attributes[:assignee]
63
+
62
64
  new attributes.merge(
63
65
  _links: Ghub::Models::Links.for(attributes[:_links]),
64
- assignee: Ghub::Models::User[attributes[:assignee]],
66
+ assignee: (Ghub::Models::User[assignee] if assignee),
65
67
  assignees: attributes[:assignees].map { |data| Ghub::Models::User[data] },
66
68
  base: Ghub::Models::Branch[attributes[:base]],
67
69
  head: Ghub::Models::Branch[attributes[:head]],
data/lib/ghub/endpoints/pulls/responses/show.rb CHANGED
@@ -6,13 +6,13 @@ module Ghub
6
6
  module Responses
7
7
  # Defines a single pull request.
8
8
  Show = Dry::Schema.Params do
9
- required(:_links).hash(Ghub::Responses::Links)
9
+ required(:_links).hash Ghub::Responses::Links
10
10
  required(:active_lock_reason).maybe :string
11
- required(:assignee).hash(Ghub::Responses::User)
12
- required(:assignees).array(Ghub::Responses::User)
11
+ required(:assignee).maybe :hash, Ghub::Responses::User
12
+ required(:assignees).array Ghub::Responses::User
13
13
  required(:author_association).filled :string
14
14
  required(:auto_merge).maybe :bool
15
- required(:base).hash(Ghub::Responses::Branch)
15
+ required(:base).hash Ghub::Responses::Branch
16
16
  required(:body).filled :string
17
17
  required(:closed_at).filled :string
18
18
  required(:comments_url).filled :string
@@ -20,11 +20,11 @@ module Ghub
20
20
  required(:created_at).filled :string
21
21
  required(:diff_url).filled :string
22
22
  required(:draft).filled :bool
23
- required(:head).hash(Ghub::Responses::Branch)
23
+ required(:head).hash Ghub::Responses::Branch
24
24
  required(:html_url).filled :string
25
25
  required(:id).filled :integer
26
26
  required(:issue_url).filled :string
27
- required(:labels).array(Ghub::Responses::Label)
27
+ required(:labels).array Ghub::Responses::Label
28
28
  required(:locked).filled :bool
29
29
  required(:merge_commit_sha).filled :string
30
30
  required(:merged_at).maybe :date_time
@@ -41,7 +41,7 @@ module Ghub
41
41
  required(:title).filled :string
42
42
  required(:updated_at).filled :string
43
43
  required(:url).filled :string
44
- required(:user).hash(Ghub::Responses::User)
44
+ required(:user).hash Ghub::Responses::User
45
45
 
46
46
  optional(:additions).filled :integer
47
47
  optional(:changed_files).filled :integer
data/lib/ghub/endpoints/repositories/actions/create.rb CHANGED
@@ -19,16 +19,16 @@ module Ghub
19
19
  include Transactable
20
20
 
21
21
  def call kind, body, owner: nil, **parameters
22
- path.create(kind, owner:)
23
- .bind do |url_path|
24
- pipe body,
25
- validate(request),
26
- insert(url_path, parameters, at: 0),
27
- to(client, :post),
28
- try(:parse, catch: JSON::ParserError),
29
- validate(response),
30
- to(model, :for)
31
- end
22
+ path.create(kind, owner:).bind do |url_path|
23
+ pipe body,
24
+ validate(request),
25
+ insert(url_path, at: 0),
26
+ insert(parameters),
27
+ to(client, :post),
28
+ try(:parse, catch: JSON::ParserError),
29
+ validate(response),
30
+ to(model, :for)
31
+ end
32
32
  end
33
33
  end
34
34
  end
data/lib/ghub/endpoints/repositories/actions/patch.rb CHANGED
@@ -19,16 +19,16 @@ module Ghub
19
19
  include Transactable
20
20
 
21
21
  def call owner, id, body, **parameters
22
- path.patch(owner, id)
23
- .bind do |url_path|
24
- pipe body,
25
- validate(request),
26
- insert(url_path, parameters, at: 0),
27
- to(client, :patch),
28
- try(:parse, catch: JSON::ParserError),
29
- validate(response),
30
- to(model, :for)
31
- end
22
+ path.patch(owner, id).bind do |url_path|
23
+ pipe body,
24
+ validate(request),
25
+ insert(url_path, at: 0),
26
+ insert(parameters),
27
+ to(client, :patch),
28
+ try(:parse, catch: JSON::ParserError),
29
+ validate(response),
30
+ to(model, :for)
31
+ end
32
32
  end
33
33
  end
34
34
  end
data.tar.gz.sig CHANGED
Binary file
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ghub
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 0.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
28
28
  CxDe2+VuChj4I1nvIHdu+E6XoEVlanUPKmSg6nddhkKn2gC45Kyzh6FZqnzH/CRp
29
29
  RFE=
30
30
  -----END CERTIFICATE-----
31
- date: 2022-11-07 00:00:00.000000000 Z
31
+ date: 2023-01-08 00:00:00.000000000 Z
32
32
  dependencies:
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: dry-container
@@ -50,28 +50,28 @@ dependencies:
50
50
  requirements:
51
51
  - - "~>"
52
52
  - !ruby/object:Gem::Version
53
- version: '1.5'
53
+ version: '1.6'
54
54
  type: :runtime
55
55
  prerelease: false
56
56
  version_requirements: !ruby/object:Gem::Requirement
57
57
  requirements:
58
58
  - - "~>"
59
59
  - !ruby/object:Gem::Version
60
- version: '1.5'
60
+ version: '1.6'
61
61
  - !ruby/object:Gem::Dependency
62
62
  name: dry-schema
63
63
  requirement: !ruby/object:Gem::Requirement
64
64
  requirements:
65
65
  - - "~>"
66
66
  - !ruby/object:Gem::Version
67
- version: '1.11'
67
+ version: '1.13'
68
68
  type: :runtime
69
69
  prerelease: false
70
70
  version_requirements: !ruby/object:Gem::Requirement
71
71
  requirements:
72
72
  - - "~>"
73
73
  - !ruby/object:Gem::Version
74
- version: '1.11'
74
+ version: '1.13'
75
75
  - !ruby/object:Gem::Dependency
76
76
  name: http
77
77
  requirement: !ruby/object:Gem::Requirement
@@ -92,42 +92,42 @@ dependencies:
92
92
  requirements:
93
93
  - - "~>"
94
94
  - !ruby/object:Gem::Version
95
- version: '0.2'
95
+ version: '1.0'
96
96
  type: :runtime
97
97
  prerelease: false
98
98
  version_requirements: !ruby/object:Gem::Requirement
99
99
  requirements:
100
100
  - - "~>"
101
101
  - !ruby/object:Gem::Version
102
- version: '0.2'
102
+ version: '1.0'
103
103
  - !ruby/object:Gem::Dependency
104
104
  name: refinements
105
105
  requirement: !ruby/object:Gem::Requirement
106
106
  requirements:
107
107
  - - "~>"
108
108
  - !ruby/object:Gem::Version
109
- version: '9.7'
109
+ version: '10.0'
110
110
  type: :runtime
111
111
  prerelease: false
112
112
  version_requirements: !ruby/object:Gem::Requirement
113
113
  requirements:
114
114
  - - "~>"
115
115
  - !ruby/object:Gem::Version
116
- version: '9.7'
116
+ version: '10.0'
117
117
  - !ruby/object:Gem::Dependency
118
118
  name: transactable
119
119
  requirement: !ruby/object:Gem::Requirement
120
120
  requirements:
121
121
  - - "~>"
122
122
  - !ruby/object:Gem::Version
123
- version: '0.3'
123
+ version: '0.4'
124
124
  type: :runtime
125
125
  prerelease: false
126
126
  version_requirements: !ruby/object:Gem::Requirement
127
127
  requirements:
128
128
  - - "~>"
129
129
  - !ruby/object:Gem::Version
130
- version: '0.3'
130
+ version: '0.4'
131
131
  - !ruby/object:Gem::Dependency
132
132
  name: zeitwerk
133
133
  requirement: !ruby/object:Gem::Requirement
@@ -262,14 +262,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
262
262
  requirements:
263
263
  - - "~>"
264
264
  - !ruby/object:Gem::Version
265
- version: '3.1'
265
+ version: '3.2'
266
266
  required_rubygems_version: !ruby/object:Gem::Requirement
267
267
  requirements:
268
268
  - - ">="
269
269
  - !ruby/object:Gem::Version
270
270
  version: '0'
271
271
  requirements: []
272
- rubygems_version: 3.3.25
272
+ rubygems_version: 3.4.2
273
273
  signing_key:
274
274
  specification_version: 4
275
275
  summary: A monadic GitHub API client.
metadata.gz.sig CHANGED
Binary file