mcm_phone_number_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6933711e10cc03f6a6882297c862b6e7c02910150ff6765ef830bc56c00722e
+  data.tar.gz: c9a82c80312f11c2c1156aace0a07aecf04de6079aad8fb893fcdf4a7861a69c
+SHA512:
+  metadata.gz: a2124b06593282bbb8d779ea33e1e10cdfc354dbb7109be9f1b74b1a7472e9057cecbb4a791496f83382ce21a5a226817e2eaa665a4f68c8281c8f857d733c90
+  data.tar.gz: 2730ec1944f5744f2ed32c9410c2e486932324c2e6e8b23e400c954cac0f8dcd06ab734a40052b7b6701665422f9aeb972eedfe44a34a5aaf2cd3fb1d5d68f35

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-01-23
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,193 @@
+# MCM Phone Number Generator
+
+**MCM Phone Number Generator** is a Ruby gem that provides seamless integration with My Country Mobile's [Phone Number Generator Tool](https://www.mycountrymobile.com/tools/phone-number-generator/). With this gem, developers can programmatically generate phone numbers for various countries and types (e.g., mobile, landline, VoIP) using the My Country Mobile API.
+
+---
+
+## Features
+
+- **Generate Phone Numbers:** Quickly generate phone numbers for different countries and types.
+- **Customizable Parameters:** Pass parameters like `country` and `type` to tailor your phone numbers.
+- **Easy Integration:** Simple Ruby interface with minimal setup.
+- **Error Handling:** Built-in error handling for smooth API interactions.
+
+---
+
+## Installation
+
+Add the gem to your Gemfile:
+```ruby
+gem 'mcm_phone_number_generator'
+```
+
+Then run:
+```bash
+bundle install
+```
+
+Or install it manually:
+```bash
+gem install mcm_phone_number_generator
+```
+
+---
+
+## Usage
+
+### Step 1: Require the Gem
+Load the gem into your Ruby script:
+```ruby
+require 'mcm_phone_number_generator'
+```
+
+### Step 2: Initialize the Client
+Create an instance of the client. Specify the API URL for My Country Mobile:
+```ruby
+client = MCMPhoneNumberGenerator::Client.new("https://www.mycountrymobile.com/api/v1")
+```
+
+### Step 3: Generate a Phone Number
+Call the `generate_phone_number` method with the required parameters:
+```ruby
+params = { country: "US", type: "mobile" }
+result = client.generate_phone_number(params)
+puts "Generated Phone Number: #{result['number']}"
+```
+
+#### Example Output
+```json
+{
+  "number": "+1-555-123-4567",
+  "country": "US",
+  "type": "mobile"
+}
+```
+
+---
+
+## API Parameters
+
+The following parameters can be passed to the `generate_phone_number` method:
+
+| Parameter | Type     | Required | Description                          |
+|-----------|----------|----------|--------------------------------------|
+| `country` | `String` | Yes      | The country code (e.g., "US").       |
+| `type`    | `String` | Yes      | The type of number (e.g., "mobile"). |
+
+---
+
+## Error Handling
+
+The gem includes robust error handling. Here's an example of how to handle errors gracefully:
+```ruby
+begin
+  result = client.generate_phone_number(params)
+  puts "Generated Phone Number: #{result['number']}"
+rescue MCMPhoneNumberGenerator::APIError => e
+  puts "An error occurred: #{e.message}"
+end
+```
+
+Common error scenarios:
+- **Network Errors:** Raised if there are issues connecting to the API.
+- **Invalid Parameters:** Raised if required parameters are missing or invalid.
+- **API Errors:** Raised if the API returns a non-successful response (e.g., `400 Bad Request`).
+
+---
+
+## Development
+
+To contribute or modify this gem:
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/your-username/mcm_phone_number_generator.git
+   cd mcm_phone_number_generator
+   ```
+2. Install dependencies:
+   ```bash
+   bundle install
+   ```
+3. Run tests:
+   ```bash
+   bundle exec rspec
+   ```
+
+---
+
+## Example Application
+
+Here’s a quick example of how you can use this gem in a real-world application:
+```ruby
+require 'mcm_phone_number_generator'
+
+client = MCMPhoneNumberGenerator::Client.new("https://www.mycountrymobile.com/api/v1")
+params = { country: "IN", type: "landline" }
+
+begin
+  result = client.generate_phone_number(params)
+  puts "Generated Phone Number: #{result['number']}"
+rescue MCMPhoneNumberGenerator::APIError => e
+  puts "Error: #{e.message}"
+end
+```
+
+---
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request if you'd like to contribute to this gem.
+
+To contribute:
+1. Fork the repository.
+2. Create a new branch for your feature or bugfix:
+   ```bash
+   git checkout -b my-new-feature
+   ```
+3. Commit your changes:
+   ```bash
+   git commit -am 'Add new feature'
+   ```
+4. Push to the branch:
+   ```bash
+   git push origin my-new-feature
+   ```
+5. Open a pull request on GitHub.
+
+---
+
+## License
+
+This gem is open-source and available under the [MIT License](https://opensource.org/licenses/MIT).
+
+---
+
+## Additional Resources
+
+- [My Country Mobile Phone Number Generator Tool](https://www.mycountrymobile.com/tools/phone-number-generator/)
+- [Ruby Gems Documentation](https://guides.rubygems.org/)
+- [HTTParty Documentation](https://github.com/jnunemaker/httparty)
+
+---
+
+## Contact
+
+For support or questions, reach out at:
+- **Email:** info@mycountrymobile.com
+- **Website:** [My Country Mobile](https://www.mycountrymobile.com)
+```
+
+---
+
+### **Key Features of This README**
+1. **Comprehensive Documentation**:
+   - Includes installation instructions, usage examples, API parameters, and error handling.
+2. **Development Instructions**:
+   - Clearly explains how contributors can set up and test the gem.
+3. **Real Examples**:
+   - Provides sample code and example outputs.
+4. **Additional Resources**:
+   - Links to related tools and documentation.
+5. **Professional Layout**:
+   - Easy to read with clear sections and formatting.
+
+---

data/lib/mcm_phone_number_generator/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module McmPhoneNumberGenerator
+  VERSION = "0.1.0"
+end

data/lib/mcm_phone_number_generator.rb

@@ -0,0 +1,45 @@
+require 'httparty'
+
+module MCMPhoneNumberGenerator
+  class APIError < StandardError; end
+
+  class Client
+    include HTTParty
+
+    def initialize(base_uri = 'https://www.mycountrymobile.com/api/v1')
+      self.class.base_uri(base_uri)
+      @headers = { 'Content-Type' => 'application/json' } # Removed Authorization header
+    end
+
+    def generate_phone_number(params = {})
+      # Validate required parameters
+      validate_params!(params)
+
+      # Log the request for debugging purposes (optional)
+      puts "Requesting phone number generation with params: #{params}"
+
+      # Make the POST request
+      response = self.class.post('/phone-number-generator', headers: @headers, body: params.to_json)
+
+      # Raise an error if the response is unsuccessful
+      raise APIError, "Error: #{response.code} - #{response.message}" unless response.success?
+
+      # Parse and return the JSON response
+      JSON.parse(response.body)
+    rescue HTTParty::Error => e
+      raise APIError, "Network error occurred: #{e.message}"
+    rescue JSON::ParserError => e
+      raise APIError, "Response parsing error: #{e.message}"
+    end
+
+    private
+
+    def validate_params!(params)
+      required_keys = [:country, :type]
+      missing_keys = required_keys.select { |key| !params.key?(key) }
+      unless missing_keys.empty?
+        raise ArgumentError, "Missing required parameters: #{missing_keys.join(', ')}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: mcm_phone_number_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joanna
+bindir: exe
+cert_chain: []
+date: 2025-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.30'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.30'
+description: This gem allows developers to programmatically generate phone numbers
+  using My Country Mobile's API. It supports country-specific and type-specific phone
+  number generation with easy Ruby integration.
+email:
+- info@mycountrymobile.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/mcm_phone_number_generator.rb
+- lib/mcm_phone_number_generator/version.rb
+homepage: https://www.mycountrymobile.com/tools/phone-number-generator/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://www.mycountrymobile.com/tools/phone-number-generator/
+  source_code_uri: https://github.com/khanaariyan/mcm_phone_number_generator
+  changelog_uri: https://github.com/khanaariyan/mcm_phone_number_generator/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A Ruby gem for interacting with My Country Mobile's Phone Number Generator
+  tool.
+test_files: []