mcm_phone_number_generator 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d674ca04d23cf8c9fd6550cb2d04e88b37014f9a32583d3e4e7d7a328ade45e
-  data.tar.gz: 41f01059cdf860f4b5910aaaa007c482737c8bd093822de92153c81370604590
+  metadata.gz: '09059b88c55fa03fb1d0a0aea1fb452445e8ebd37252a8658248f5a398414323'
+  data.tar.gz: 812d4027090a326a9eef23c343a9a02c778a8ac60335f1f6cd8b352cefe2ff4e
 SHA512:
-  metadata.gz: 94bb5039299998f8b0b29743ca39a3274f36d795b950b68b60f5ece096c5d1139da3ff857898641bae658b0abc7008758f092410f6e5d77ffc16fd4f649719d3
-  data.tar.gz: 4428e624fa4f5bebc9165dbb52221a93293c252ae73f10cc12043046a5e078492cb23e08e2124089edfd72bb43447d8bb9744078eff718ff08b66b920a0c0135
+  metadata.gz: 05fcafb3061eaee0017073d1df4bf467cc956390a4b612687b68ccc827610b08a4db09986a447e7fcadd39d3e6e10e916173e49cbd716c411922db41a0eb7336
+  data.tar.gz: 416974ab30b91ed2e494a889ec849e4d3cda2210d740cc319ea3dbf250fc472786cde7e5aa02ece99857633cf4ab913580ac026053d72087c64ed4da2cce6780

data/README.md

@@ -18,106 +18,102 @@
 Add the gem to your Gemfile:
 ```ruby
 gem 'mcm_phone_number_generator'
-```
-
 Then run:
-```bash
-bundle install
-```
 
+bash
+Copy
+Edit
+bundle install
 Or install it manually:
-```bash
-gem install mcm_phone_number_generator
-```
-
----
-
-## Usage
 
-### Step 1: Require the Gem
+bash
+Copy
+Edit
+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
+ruby
+Copy
+Edit
+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
+
+ruby
+Copy
+Edit
 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:
 
-### Step 3: Generate a Phone Number
-Call the `generate_phone_number` method with the required parameters:
-```ruby
+ruby
+Copy
+Edit
 params = { country: "US", type: "mobile" }
 result = client.generate_phone_number(params)
 puts "Generated Phone Number: #{result['number']}"
-```
-
-#### Example Output
-```json
+Example Output
+json
+Copy
+Edit
 {
   "number": "+1-555-123-4567",
   "country": "US",
   "type": "mobile"
 }
-```
-
----
-
-## API Parameters
-
-The following parameters can be passed to the `generate_phone_number` method:
+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
+Parameter	Type	Required	Description
+country	String	Yes	The country code (e.g., "US").
+type	String	Yes	The type of number (e.g., "mobile").
+Phone Number Generator Tool
+This gem is powered by the My Country Mobile Phone Number Generator Tool. For additional customization and manual testing, you can access the tool directly.
 
+Error Handling
 The gem includes robust error handling. Here's an example of how to handle errors gracefully:
-```ruby
+
+ruby
+Copy
+Edit
 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
 
+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
 
+Clone the repository:
+bash
+Copy
+Edit
+git clone https://github.com/khanaariyan/mcm_phone_number_generator.git
+cd mcm_phone_number_generator
+Install dependencies:
+bash
+Copy
+Edit
+bundle install
+Run tests:
+bash
+Copy
+Edit
+bundle exec rspec
+Example Application
 Here’s a quick example of how you can use this gem in a real-world application:
-```ruby
+
+ruby
+Copy
+Edit
 require 'mcm_phone_number_generator'
 
 client = MCMPhoneNumberGenerator::Client.new("https://www.mycountrymobile.com/api/v1")
@@ -129,65 +125,51 @@ begin
 rescue MCMPhoneNumberGenerator::APIError => e
   puts "Error: #{e.message}"
 end
-```
-
----
-
-## Contributing
-
+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
 
+Fork the repository.
+Create a new branch for your feature or bugfix:
+bash
+Copy
+Edit
+git checkout -b my-new-feature
+Commit your changes:
+bash
+Copy
+Edit
+git commit -am 'Add new feature'
+Push to the branch:
+bash
+Copy
+Edit
+git push origin my-new-feature
+Open a pull request on GitHub.
+License
+This gem is open-source and available under the MIT License.
+
+Additional Resources
+My Country Mobile
+Phone Number Generator Tool
+Ruby Gems Documentation
+HTTParty Documentation
+Contact
 For support or questions, reach out at:
-- **Email:** info@mycountrymobile.com
-- **Website:** [My Country Mobile](https://www.mycountrymobile.com)
-```
+
+Email: info@mycountrymobile.com
+Website: My Country Mobile
+yaml
+Copy
+Edit
 
 ---
 
-### **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.
-
----
+### **What’s New in This README**
+1. **Added a Dedicated Section for "Phone Number Generator Tool":**
+   - Highlights the external tool link.
+2. **Enhanced Layout:**
+   - Made it easier to navigate for new users.
+3. **Emphasized Error Handling and Example Application:**
+   - Demonstrates real-world usage and API capabilities.

data/lib/mcm_phone_number_generator/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module MCMPhoneNumberGenerator
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mcm_phone_number_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Joanna