poodle-ruby 1.0.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 ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: e75538a170e922587d7cd3f4eaa08dc36b2898538e805c6c26cdc8337fc96388
4
+ data.tar.gz: 101dbf4fb3066bbda66d618fc65c3684e93481148fb6e4cb6e08a8734c6bf219
5
+ SHA512:
6
+ metadata.gz: 96d53647e88eeb5288a7584fb085e7c32badfe379bc78747b807123f7dd651b1b046d3618a783d238c892914c5d0f9d689c9c3d6d1a8ba5b43eb13dd1e2d7e76
7
+ data.tar.gz: 6fbf47f1ff168074eb3c433ff9cf13cbc4e2655e01d6eb3eb90e4f42e4869f056ae7ac031549768eab15c5949c8b467db3798b68661e7a6233ff09f1b6a92cb8
data/.rspec ADDED
@@ -0,0 +1 @@
1
+ --require spec_helper
data/.rubocop.yml ADDED
@@ -0,0 +1,65 @@
1
+ AllCops:
2
+ SuggestExtensions: false
3
+ TargetRubyVersion: 3.0
4
+ NewCops: enable
5
+ Exclude:
6
+ - "vendor/**/*"
7
+ - "bin/**/*"
8
+ - "spec/fixtures/**/*"
9
+
10
+ # Style preferences
11
+ Style/StringLiterals:
12
+ Enabled: true
13
+ EnforcedStyle: double_quotes
14
+
15
+ Style/Documentation:
16
+ Enabled: false
17
+
18
+ Style/FrozenStringLiteralComment:
19
+ Enabled: true
20
+
21
+ # Layout preferences
22
+ Layout/LineLength:
23
+ Max: 120
24
+ Exclude:
25
+ - "spec/**/*"
26
+
27
+ # Metrics
28
+ Metrics/BlockLength:
29
+ Exclude:
30
+ - "spec/**/*"
31
+ - "poodle-ruby.gemspec"
32
+ - "lib/poodle/rails/tasks.rake"
33
+ - "examples/**/*"
34
+
35
+ Metrics/MethodLength:
36
+ Max: 20
37
+ Exclude:
38
+ - "spec/**/*"
39
+ - "examples/**/*"
40
+
41
+ Metrics/ClassLength:
42
+ Max: 170
43
+
44
+ # Naming
45
+ Naming/FileName:
46
+ Exclude:
47
+ - "lib/poodle-ruby.rb"
48
+
49
+ # Security
50
+ Security/YAMLLoad:
51
+ Enabled: true
52
+
53
+ Metrics/AbcSize:
54
+ Max: 20
55
+ Exclude:
56
+ - "examples/**/*"
57
+
58
+ Metrics/CyclomaticComplexity:
59
+ Max: 8
60
+ Exclude:
61
+ - "examples/**/*"
62
+
63
+ Metrics/PerceivedComplexity:
64
+ Exclude:
65
+ - "examples/**/*"
data/.yardopts ADDED
@@ -0,0 +1,12 @@
1
+ --markup markdown
2
+ --markup-provider kramdown
3
+ --output-dir doc
4
+ --protected
5
+ --private
6
+ --title "Poodle Ruby SDK Documentation"
7
+ --readme README.md
8
+ --files CHANGELOG.md,LICENSE
9
+ lib/**/*.rb
10
+ -
11
+ README.md
12
+ CHANGELOG.md
@@ -0,0 +1,78 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+ We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8
+
9
+ ## Our Standards
10
+
11
+ Examples of behavior that contributes to a positive environment for our community include:
12
+
13
+ * Demonstrating empathy and kindness toward other people
14
+ * Being respectful of differing opinions, viewpoints, and experiences
15
+ * Giving and gracefully accepting constructive feedback
16
+ * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17
+ * Focusing on what is best not just for us as individuals, but for the overall community
18
+
19
+ Examples of unacceptable behavior include:
20
+
21
+ * The use of sexualized language or imagery and unwelcome sexual attention or advances
22
+ * Trolling, insulting or derogatory comments, and personal or political attacks
23
+ * Public or private harassment
24
+ * Publishing others' private information, such as a physical or email address, without their explicit permission
25
+ * Other conduct which could reasonably be considered inappropriate in a professional setting
26
+
27
+ ## Enforcement Responsibilities
28
+
29
+ Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
30
+
31
+ Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
32
+
33
+ ## Scope
34
+
35
+ This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36
+
37
+ ## Enforcement
38
+
39
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project team at support@usepoodle.com. All complaints will be reviewed and investigated promptly and fairly.
40
+
41
+ All project maintainers are obligated to respect the privacy and security of the reporter of any incident.
42
+
43
+ ## Enforcement Guidelines
44
+
45
+ Project maintainers will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46
+
47
+ ### 1. Correction
48
+
49
+ **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50
+
51
+ **Consequence**: A private, written warning from project maintainers, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
52
+
53
+ ### 2. Warning
54
+
55
+ **Community Impact**: A violation through a single incident or series of actions.
56
+
57
+ **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
58
+
59
+ ### 3. Temporary Ban
60
+
61
+ **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62
+
63
+ **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
64
+
65
+ ### 4. Permanent Ban
66
+
67
+ **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
68
+
69
+ **Consequence**: A permanent ban from any sort of public interaction within the community.
70
+
71
+ ## Attribution
72
+
73
+ This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
74
+
75
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
76
+
77
+ For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq.
78
+
data/CONTRIBUTING.md ADDED
@@ -0,0 +1,151 @@
1
+ # Contributing to Poodle Ruby SDK
2
+
3
+ Thank you for your interest in contributing to the Poodle Ruby SDK! We welcome contributions from the community.
4
+
5
+ ## Development Setup
6
+
7
+ ### Requirements
8
+
9
+ - Ruby 3.0 or higher
10
+ - Bundler
11
+ - Git
12
+
13
+ ### Setup
14
+
15
+ 1. Fork the repository
16
+ 2. Clone your fork:
17
+
18
+ ```bash
19
+ git clone https://github.com/yourusername/poodle-ruby.git
20
+ cd poodle-ruby
21
+ ```
22
+
23
+ 3. Install dependencies:
24
+ ```bash
25
+ bundle install
26
+ ```
27
+
28
+ ## Development Workflow
29
+
30
+ ### Running Tests
31
+
32
+ ```bash
33
+ # Run all tests
34
+ bundle exec rspec
35
+
36
+ # Run specific test file
37
+ bundle exec rspec spec/poodle/client_spec.rb
38
+
39
+ # Run tests with coverage
40
+ bundle exec rspec
41
+ # Coverage report will be generated in coverage/index.html
42
+ ```
43
+
44
+ ### Code Quality
45
+
46
+ ```bash
47
+ # Check code style
48
+ bundle exec rubocop
49
+
50
+ # Fix code style issues automatically
51
+ bundle exec rubocop -a
52
+
53
+ # Generate documentation
54
+ bundle exec yard doc
55
+
56
+ # View documentation
57
+ bundle exec yard server
58
+ ```
59
+
60
+ ### Making Changes
61
+
62
+ 1. Create a feature branch:
63
+
64
+ ```bash
65
+ git checkout -b feature/your-feature-name
66
+ ```
67
+
68
+ 2. Make your changes
69
+ 3. Write or update tests
70
+ 4. Ensure all tests pass and code style is correct
71
+ 5. Commit your changes with a descriptive message
72
+ 6. Push to your fork
73
+ 7. Create a pull request
74
+
75
+ ## Code Standards
76
+
77
+ ### Ruby Standards
78
+
79
+ - Follow the Ruby Style Guide
80
+ - Use RuboCop for code style enforcement (configuration in `.rubocop.yml`)
81
+ - Maintain Ruby 3.0+ compatibility
82
+ - Use frozen string literals (`# frozen_string_literal: true`)
83
+ - Write comprehensive YARD documentation
84
+
85
+ ### Testing Standards
86
+
87
+ - Write RSpec tests for all new functionality
88
+ - Maintain or improve test coverage
89
+ - Use descriptive test descriptions
90
+ - Test both success and failure scenarios
91
+ - Use VCR for HTTP interaction testing when appropriate
92
+
93
+ ### Documentation Standards
94
+
95
+ - Document all public methods with YARD
96
+ - Update README.md if adding new features
97
+ - Include code examples in documentation
98
+ - Keep examples in the `examples/` directory up to date
99
+
100
+ ## Pull Request Process
101
+
102
+ 1. Ensure your code follows the existing style and conventions
103
+ 2. Run the full test suite and ensure all tests pass
104
+ 3. Run RuboCop and fix any style issues
105
+ 4. Update documentation as needed
106
+ 5. Write a clear PR description explaining your changes
107
+ 6. Link any relevant issues
108
+
109
+ ## We Use [Github Flow](https://docs.github.com/en/get-started/using-github/github-flow)
110
+
111
+ Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
112
+
113
+ 1. Fork the repo and create your branch from `main`.
114
+ 2. If you've added code that should be tested, add tests.
115
+ 3. If you've changed APIs, update the documentation.
116
+ 4. Ensure the test suite passes.
117
+ 5. Make sure your code follows RuboCop guidelines.
118
+ 6. Issue that pull request!
119
+
120
+ ## Any contributions you make will be under the MIT Software License
121
+
122
+ In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
123
+
124
+ ## Report bugs using GitHub's [issue tracker](https://github.com/usepoodle/poodle-ruby/issues)
125
+
126
+ We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/usepoodle/poodle-ruby/issues/new); it's that easy!
127
+
128
+ ## Write bug reports with detail, background, and sample code
129
+
130
+ **Great Bug Reports** tend to have:
131
+
132
+ - A quick summary and/or background
133
+ - Steps to reproduce
134
+ - Be specific!
135
+ - Give sample code if you can.
136
+ - What you expected would happen
137
+ - What actually happens
138
+ - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
139
+
140
+ ## Use a Consistent Coding Style
141
+
142
+ - Follow the RuboCop configuration in `.rubocop.yml`
143
+ - Use double quotes for strings
144
+ - 2 spaces for indentation
145
+ - Maximum line length of 120 characters
146
+ - Write meaningful commit messages
147
+ - Use descriptive variable and method names
148
+
149
+ ## License
150
+
151
+ By contributing, you agree that your contributions will be licensed under its MIT License.
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Poodle
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.