bosta 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b763bc46efc4f314e066658f3a4f20be1df8bba6ae33e07359dbdbb9b108d9fb
+  data.tar.gz: bc2c61b3c495038afcf82fe0ae253a3299994516e72b3487cc0d12734f417bce
+SHA512:
+  metadata.gz: 1d4813c16ba102666cdac9db2b3c7b5f56bd5d1799d409df302e8678db97c6accece4a5ad1d742955db92b20dfc93458e4a81cdb6cde5d874a919c3647becc36
+  data.tar.gz: 271b47d8505663ae7c2d4c385ef85a07b98f57be6dfbf5711c1e41b348f631b235d6d8a438e4822a896836c1a1ac203085aaff25a96e046407c3c8f13c4f9e06

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or 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. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at `:author_email`. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Contributing
+
+We are open to, and grateful for, any contributions made by the community. By contributing to Bosta Ruby SDK, you agree to abide by the [code of conduct](https://github.com/bostaapp/bosta-ruby/blob/master/CONTRIBUTING.md).
+
+
+# Code Style
+
+- Consider the best practices and rules recommended by the
+  [Ruby Community Style Guide](https://github.com/bbatsov/ruby-style-guide).
+- To check style linting run the following command:
+    ```bash
+    gem install rubocop
+
+    rubocop {source_file_or_directory}
+
+    ```
+- You can auto-correct offenses with the following command:
+    ```bash
+     rubocop -a
+    ```
+
+### Commit Messages
+
+Commit messages should be verb based, using the following pattern:
+
+- `Fixing ...`
+- `Adding ...`
+- `Updating ...`
+- `Removing ...`
+
+### Documentation
+
+Please update the [docs](README.md) accordingly so that there are no discrepancies between the API and the documentation.
+
+### Developing
+
+- `bundle install` install dependencies
+
+### Releasing
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
+
+- **Create feature branches** - Don't ask us to pull from your master branch.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Bosta
+
+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,126 @@
+## Bosta Ruby Package
+The Bosta Ruby SDK provides convenient access to the Bosta API from applications written in the Ruby language.
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Contribution](#contribution)
+- [License](#license)
+
+## Installation
+
+```bash
+gem install bosta
+```
+
+## Usage
+
+#### Initiating Bosta Client
+```bash
+require('bosta');
+
+Bosta.api_key= ENV['API_KEY']
+Bosta.base_url= ENV['BASE_URL']
+```
+
+`API_KEY` is your integartion api key with bosta, to get an api key you must be registered, here is the registration link [Bosta](https://business.bosta.co/signup). And `BASE_URL` is the url to bosta Apis wheither it's [staging](https://stg-app.bosta.co) or [production](https://app.bosta.co). If `BASE_URL` is not sent in initialization as parameter it's [production](https://app.bosta.co) by default.
+
+#### Use initiated bosta client to do the functionality of the following
+
+##### list utilities
+
+###### delivery types to use in shipment creation
+```bash
+deliveryTypes = Bosta::DELIVERY_TYPES;
+```
+###### pickup timeslots to use in pickup creation
+```bash
+pickupTimeSlots_1 = Bosta::TIME_SLOT_10_TO_13;
+pickupTimeSlots_2 = Bosta::TIME_SLOT_13_TO_16;
+```
+
+##### Shipments
+###### created shipment
+```bash
+receiver1 = Bosta::Receiver.new('Ahmad Mohamad', '01029394959')
+address1 = Bosta::Address.new('EG-01', 'address firstline')
+type = Bosta::DELIVERY_TYPES[:SEND]
+spec = Bosta::Specs.new(Bosta::DELIVERY_SIZES[:SMALL])
+create_delivery = Bosta::Delivery.create(type, 100, receiver1, address1,  spec)
+
+delivery_id = create_delivery['_id'];
+tracking_number = create_delivery['trackingNumber'];
+```
+###### update shipment by id
+```bash
+update_delivery = Bosta::Delivery.update(delivery_id, cod=nil, address= nil, receiver = nil, business_reference=nil, webhook_url=nil, notes=nil);
+```
+###### list all created shipments
+```bash
+deliveries = Bosta::Delivery.find_all_deliveries();
+```
+###### get shipment by tracking number
+```bash
+delivery = Bosta::Delivery.find_delivery_by_traking_number(tracking_number);
+```
+###### track shipment
+```bash
+tracking_history = Bosta::Delivery.track_delivery(tracking_number);
+```
+###### print airwayBill
+```bash
+airwayBill = Bosta::Delivery.print_delivery_awb(delivery_id);
+```
+###### terminate delivery
+```bash
+Bosta::Delivery.terminate_delivery(delivery_id);
+```
+
+##### pickups
+###### get your pickup location
+```bash
+pickup_locations = Bosta::Pickup.find_pickup_locations();
+business_location_id = pickup_locations["pickupLocations"][0]['_id'];
+```
+###### create pickup
+```bash
+create_pickup = Bosta::Pickup.create(business_location_id, scheduled_date, scheduled_time_slot, contact_person);
+```
+###### update pickup
+```bash
+update_pickup = Bosta::Pickup.update(pickup_id, business_location_id=nil, scheduled_date=nil, scheduled_time_slot=nil, contact_person=nil, notes=nil);
+```
+###### get all pickups
+```bash
+pickup_requests = Bosta::Pickup.find_pickups();
+```
+###### get pickup by id
+```bash
+pikcup_request = Bosta::Pickup.find_pickup_by_id(pickup_id);
+```
+###### delete pickup
+```bash
+Bosta::Pickup.delete_pickup(pickup_id);
+```
+
+##### cities
+###### get all cities to select one of them and its code in shipment
+```bash
+cities = Bosta::City.find_all_cities();
+```
+
+##### zones
+###### get zones of the city by city id to use one of them in the shipment
+```bash
+zones = Bosta::City.show_city_zones(city_id);
+```
+
+## Contribution
+
+We are open to, and grateful for, any contributions made by the community.
+By contributing to Bosta, you agree to abide by the code of conduct.
+- [Contributing Guide](CONTRIBUTING.md) 
+- [Code of Conduct](CODE_OF_CONDUCT.md)
+
+## License
+
+The MIT License (MIT) [License](LICENSE).

data/bosta.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name = 'bosta'
+  s.version = '0.0.1'
+  s.authors = ['Ahmad Elkhateeb']
+  s.email = 'ahmed.khateeb@bosta.co'
+  s.date = '2020-11-01'
+  s.licenses = ['MIT']
+  s.homepage = 'https://github.com/bostaapp/bosta-ruby'
+  s.summary = 'A Ruby client SDK for Bosta APIs integration.'
+  s.description = 'This gem simplifies the integration process with Bosta.
+  create, update and track your shimpents easily'
+  s.required_ruby_version = '>= 2.4'
+  s.files = Dir[
+    'README.md',
+    'LICENSE',
+    'CONTRIBUTING.md',
+    'CODE_OF_CONDUCT.md',
+    'lib/**/*.rb',
+    'bosta.gemspec'
+  ]
+  s.extra_rdoc_files = ['README.md']
+  s.test_files = Dir.glob('test/*_test.rb')
+  s.add_runtime_dependency 'faraday', '~> 1.1.0'
+  s.add_development_dependency 'rubocop', '~> 0.60'
+  s.add_development_dependency 'rubocop-performance', '~> 1.5'
+  s.add_development_dependency 'rubocop-rspec', '~> 1.37'
+end

data/lib/bosta.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative('bosta/config')
+require_relative('bosta/resource')
+require_relative('bosta/utils/bosta_object')
+require_relative('bosta/utils/address')
+require_relative('bosta/utils/specs')
+require_relative('bosta/utils/receiver')
+require_relative('bosta/utils/contact_person')
+require_relative('bosta/utils/constants')
+require_relative('bosta/cities/city')
+require_relative('bosta/zones/zone')
+require_relative('bosta/deliveries/delivery')
+require_relative('bosta/pickups/pickup')
+
+#= Bosta
+#
+# * Create and list shimpents easily using Delivery
+# * Create and list your pickups using Pickup
+# * List Different cities that we cover using City
+# * List all zones that we cover using Zone
+#
+#== Start with bosta
+#
+# Visit https://bosta.co/
+#
+module Bosta
+  Bosta.base_url = 'https://app.bosta.co' # Default base_url
+end

data/lib/bosta/cities/city.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Bosta
+  ##
+  # This class represents the citoes that your addresses will contain in creating deliveries and pickups.
+  class City
+    ##
+    # Get all cities names and codes.
+    #
+    # Here you will find all city codes that you will need to provide in
+    # creating shipments and pickups.
+    #
+    # An Error is raised if the endpoint didn't return data
+
+    def self.find_all_cities
+      Bosta::Resource.send('get', 'cities')
+    end
+
+    ##
+    # Get all zones in a specific city.
+    #
+    # +cityId+ represents the city id for which zones is obtained
+    # an exception raises.
+    #
+    # An Error is raised if the endpoint didn't return data or wrong +cityId+ was given
+
+    def self.show_city_zones(city_id)
+      Bosta::Resource.send('get', "cities/#{city_id}/zones")
+    end
+  end
+end

data/lib/bosta/config.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Configuration of bosta module
+module Bosta
+  class << self
+    attr_writer :api_key, :base_url
+
+    #:nodoc:
+    def api_key
+      get_key :api_key
+    end
+
+    #:nodoc:
+    def base_url
+      get_key :base_url
+    end
+
+    private
+
+    def get_key(key)
+      instance_variable_get("@#{key}") || raise("Set Bosta.#{key} to use this feature")
+    end
+  end
+end

data/lib/bosta/deliveries/delivery.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Bosta
+  # Find, create, update, and delete deliveries
+  class Delivery
+    #=== Create new delivery
+    # * +package_type+ should be on of DELIVERY_TYPES in Bosta module
+    # * +cod+ should be 0 in case delivery type = CRP
+    # * +address+ should be of type Address
+    # * +receiver+ should be of type Receiver
+    # * +specs+ (optinal) should be of type Specs
+    # * +business_reference+ (optional) String
+    # * +webhook_url+ (optional) String url
+    # * +notes+ String
+    #
+
+    def self.create(package_type,
+                    cod,
+                    receiver,
+                    address,
+                    specs = nil,
+                    business_reference = nil,
+                    webhook_url = nil,
+                    notes = nil)
+      params_hash = {
+        type: package_type,
+        cod: cod,
+        address: address,
+        receiver: receiver,
+        businessReference: business_reference,
+        specs: specs,
+        webhookUrl: webhook_url,
+        notes: notes
+      }
+      delivery_hash = Delivery.format_params(params_hash)
+      Bosta::Resource.send('post', 'deliveries', delivery_hash)
+    end
+
+    #=== Edit delivery data
+    # * +delivery_id+
+    # * +cod+ (optional) the cash on delivery (number)
+    # * +address+ (optional) should be of type Address
+    # * +receiver+ (optional) should be of type Receiver
+    # * +business_reference+ (optional) String
+    # * +webhook_url+ (optional) String url
+    # * +notes+ (optional) String
+    #
+
+    def self.update(delivery_id,
+                    cod = nil,
+                    address = nil,
+                    receiver = nil,
+                    business_reference = nil,
+                    webhook_url = nil,
+                    notes = nil)
+      params_hash = {
+        cod: cod,
+        address: address,
+        receiver: receiver,
+        businessReference: business_reference,
+        webhookUrl: webhook_url,
+        notes: notes
+      }
+      delivery_hash = Delivery.format_params(params_hash)
+      Bosta::Resource.send('put', "deliveries/#{delivery_id}", delivery_hash)
+    end
+
+    #
+    # * Get all your created Deliveries
+    #
+
+    def self.find_all_deliveries
+      Bosta::Resource.send('get', 'deliveries')
+    end
+
+    #
+    # * Get specific delivery using +tracking_number+
+    #
+
+    def self.find_delivery_by_traking_number(tracking_number)
+      Bosta::Resource.send('get', "deliveries/#{tracking_number}")
+    end
+
+    #
+    # * see delivery tracking using +tracking_number+
+    #
+
+    def self.track_delivery(tracking_number)
+      Bosta::Resource.send('get', "deliveries/#{tracking_number}/tracking")
+    end
+
+    #
+    # * get base64 pdf data representing the package using +delivery_id+
+    #
+
+    def self.print_delivery_awb(delivery_id)
+      Bosta::Resource.send('get', "deliveries/awb/#{delivery_id}")
+    end
+
+    #
+    # * Terminate the shipment +delivery_id+
+    #
+
+    def self.terminate_delivery(delivery_id)
+      Bosta::Resource.send('delete', "deliveries/#{delivery_id}")
+    end
+
+    #:nodoc: all
+    def self.format_params(params_hash)
+      params_hash = Delivery.check_objects_types(params_hash)
+      delivery_hash = {}
+      params_hash.each do |key, value|
+        if key == :address && !value.nil?
+          forward_types = [Bosta::DELIVERY_TYPES[:SEND], Bosta::DELIVERY_TYPES[:EXCHANGE]]
+          delivery_hash[:pickupAddress] = value unless forward_types.include? params_hash[:type]
+          delivery_hash[:dropOffAddress] = value if forward_types.include? params_hash[:type]
+        else
+          delivery_hash[key] = value
+        end
+      end
+      delivery_hash
+    end
+
+    #:nodoc: all
+    def self.check_objects_types(params_hash)
+      object_strings = %w[receiver address specs]
+
+      object_strings.each do |string|
+        upper_string = string[0].upcase + string[1..-1]
+        bosta_object = Object.const_get("Bosta::#{upper_string}")
+        next if params_hash[:"#{string}"].nil?
+        unless params_hash[:"#{string}"].instance_of?(bosta_object)
+          raise "#{string} should be of Class Bosta::#{upper_string}"
+        end
+
+        params_hash[:"#{string}"] = params_hash[:"#{string}"].format_obj
+      end
+      params_hash.compact
+    end
+  end
+end

data/lib/bosta/pickups/pickup.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Bosta
+  # Find, create, update, and delete pickups
+  class Pickup
+    #=== Create A new pickup
+    # * +business_location_id+ should be on of your business locations ids
+    # * +scheduled_date+ is the date to be scheduled for pickup
+    # * +scheduled_time_slot+ should be one of TIME_SLOT_10_TO_13, TIME_SLOT_13_TO_16 in Bosta
+    # * +contact_person+ should be of type ContactPerson
+    # * +notes+ (optional) String
+    #
+
+    def self.create(business_location_id, scheduled_date, scheduled_time_slot, contact_person, notes = nil)
+      unless contact_person.instance_of?(Bosta::ContactPerson)
+        raise 'contact_person should be of Class Bosta::ContactPerson'
+      end
+
+      pickup_hash = {
+        businessLocationId: business_location_id,
+        scheduledDate: scheduled_date,
+        scheduledTimeSlot: scheduled_time_slot,
+        contactPerson: contact_person.format_obj
+      }
+
+      pickup_hash[:notes] = notes unless notes.nil?
+
+      Bosta::Resource.send('post', 'pickups', pickup_hash)
+    end
+
+    #=== Edit A created pickup
+    # * +pickup_id+ the id of the pickup to be updated
+    # * +business_location_id+ (optional) should be on of your business locations ids
+    # * +scheduled_date+ (optional) is the date to be scheduled for pickup
+    # * +scheduled_time_slot+ (optional) should be one of TIME_SLOT_10_TO_13, TIME_SLOT_13_TO_16 in Bosta
+    # * +contact_person+ (optional) should be of type ContactPerson
+    # * +notes+ (optional) String
+    #
+
+    def self.update(pickup_id, business_location_id = nil,
+                    scheduled_date = nil,
+                    scheduled_time_slot = nil,
+                    contact_person = nil,
+                    notes = nil)
+
+      unless contact_person.nil?
+        unless contact_person.instance_of?(Bosta::ContactPerson)
+          raise 'contact_person should be of Class Bosta::ContactPerson'
+        end
+
+        contact_person = contact_person.format_obj
+      end
+      pickup_hash = {
+        businessLocationId: business_location_id,
+        scheduledDate: scheduled_date,
+        scheduledTimeSlot: scheduled_time_slot,
+        contactPerson: contact_person,
+        notes: notes
+      }
+
+      pickup_hash = pickup_hash.compact
+      Bosta::Resource.send('put', "pickups/#{pickup_id}", pickup_hash)
+    end
+
+    #
+    # * get all your pickup locations that you will use in creating pickups
+    #
+
+    def self.find_pickup_locations
+      Bosta::Resource.send('get', 'pickup-locations')
+    end
+
+    #
+    # * get all your created pickups
+    #
+
+    def self.find_pickups(page_id = 0)
+      Bosta::Resource.send('get', 'pickups', {}, { pageId: page_id })
+    end
+
+    #
+    # * retrieve specific pickup using +pickup_id+
+    #
+
+    def self.find_pickup_by_id(pickup_id)
+      Bosta::Resource.send('get', "pickups/#{pickup_id}")
+    end
+
+    #
+    # * delete specific pickup using +pickup_id+
+    #
+
+    def self.delete_pickup(pickup_id)
+      Bosta::Resource.send('delete', "pickups/#{pickup_id}")
+    end
+  end
+end

data/lib/bosta/resource.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'json'
+
+module Bosta #:nodoc: all
+  class Resource
+    def self.connection(method)
+      conn = Faraday.new(
+        url: Bosta.base_url,
+        params: { param: '1' },
+        headers: {
+          'Content-Type' => 'application/json',
+          'Authorization': Bosta.api_key,
+          'X-Requested-By': 'ruby-sdk'
+        }
+      )
+      raise 'Not Existed Method' unless conn.respond_to? method
+
+      conn
+    end
+
+    def self.send(method, path, body = {}, params = {})
+      conn = Resource.connection(method)
+      full_path = "#{Bosta.base_url}/api/v1/#{path}"
+
+      res = conn.public_send(method, full_path) do |req|
+        req.params = params
+        req.body = body.to_json
+      end
+      res = JSON.parse(res.body)
+
+      return res['data'] || res['message'] if res['success']
+
+      # if not Success
+      raise res['message']
+    rescue StandardError
+      raise
+    end
+  end
+end

data/lib/bosta/utils/address.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Bosta
+  # Represents the address type that used by bosta apis
+  class Address < BostaObject
+    attr_accessor :city_code, :zone, :first_line, :second_line, :district, :building_number, :floor, :apartment
+
+    #=== Initialize Address Object
+    # * +city_code+ The city code like 'EG-01', you can get all cities codes from City Class
+    # * +first_line+ your address firstline
+    # * +zone+ (optional), find all zones in a city thorugh the City Class
+    # * +second_line+ (optional) Sring
+    # * +building_number+ (optional) String
+    # * +floor+ (optional) String
+    # * +apartment+ (optional) String
+    #
+    def initialize(city_code,
+                   first_line,
+                   zone = nil,
+                   second_line = nil,
+                   building_number = nil,
+                   floor = nil,
+                   apartment = nil)
+      super()
+      @city_code = city_code
+      @first_line = first_line
+      @zone = zone
+      @second_line = second_line
+      @building_number = building_number
+      @floor = floor
+      @apartment = apartment
+
+      check_required_fields('city_code', 'first_line')
+    end
+  end
+end

data/lib/bosta/utils/bosta_object.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Bosta #:nodoc: all
+  class BostaObject
+    def check_required_fields(*fields)
+      fields.map do |field|
+        value = instance_variable_get("@#{field}")
+        if !instance_variable_defined?("@#{field}") || value.nil? || value.gsub(/\s+/, '').empty?
+          raise "#{field} is not allowed to be empty"
+        end
+      end
+    end
+
+    def format_obj
+      obj = {}
+      instance_variables.map do |attribute|
+        key = attribute.to_s.gsub('@', '')
+        value = instance_variable_get(attribute)
+        camel_key = key.split('_').map(&:capitalize).join
+        camel_key[0] = camel_key[0].downcase
+        obj[camel_key] = value unless value.nil?
+      end
+      obj
+    end
+  end
+end

data/lib/bosta/utils/constants.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Bosta
+  # Set your pick in Time Slot '10:00 to 13:00'
+  TIME_SLOT_10_TO_13 = '10:00 to 13:00'
+
+  # Set your pick in Time Slot '13:00 to 16:00'
+  TIME_SLOT_13_TO_16 = '13:00 to 16:00'
+
+  #=== Four different types
+  #
+  # * SEND => 10
+  # * CASH_COLLECTION => 15
+  # * CRP => 25
+  # * EXCHANGE => 30
+  #
+
+  DELIVERY_TYPES = {
+    SEND: 10,
+    CASH_COLLECTION: 15,
+    CRP: 25,
+    EXCHANGE: 30
+  }.freeze
+
+  #=== Three different sizes
+  #
+  # * SMALL
+  # * MEDIUM
+  # * LARGE
+  #
+  DELIVERY_SIZES = {
+    SMALL: 'SMALL',
+    MEDIUM: 'MEDIUM',
+    LARGE: 'LARGE'
+  }.freeze
+end

data/lib/bosta/utils/contact_person.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Bosta
+  # Represents the contact person type that used by bosta apis
+  class ContactPerson < BostaObject
+    attr_accessor :name, :phone, :email
+
+    #=== Initialize Contact Person Object
+    # * +name+
+    # * +phone+
+    # * +email+ (optional) String
+    #
+    def initialize(name, phone, email = nil)
+      super()
+      @name = name
+      @phone = phone
+      @email = email
+
+      check_required_fields('name', 'phone')
+    end
+  end
+end

data/lib/bosta/utils/receiver.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Bosta
+  # Represents the receiver type that used by bosta apis
+  class Receiver < BostaObject
+    attr_accessor :first_name, :last_name, :phone, :email
+
+    #=== Initialize Receiver Object
+    # * +name+
+    # * +phone+
+    # * +email+ (optional) String
+    #
+    def initialize(name, phone, email = nil)
+      super()
+      names_arr = name.split
+      @first_name = names_arr.shift
+      @last_name = names_arr.join(' ')
+      @last_name = '-' if @last_name.empty?
+      @phone = phone
+      @email = email
+
+      check_required_fields('first_name', 'phone')
+    end
+  end
+end

data/lib/bosta/utils/specs.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Bosta
+  # Represents the spec type that used by bosta apis
+  class Specs < BostaObject
+    attr_accessor :size, :items_count, :desc
+
+    #=== Initialize Specs Object
+    # * +size+ (optional) String
+    # * +items_count+ (optional) String
+    # * +desc+ (optional) String
+    #
+    def initialize(size = nil, items_count = nil, desc = nil)
+      super()
+      @size = size
+      @items_count = items_count
+      @description = desc
+    end
+
+    def format_obj #:nodoc: all
+      obj = {}
+      package_details = {}
+      obj[:size] = @size unless @size.nil?
+      package_details[:items_count] = @items_count unless @items_count.nil?
+      package_details[:description] = @description unless @description.nil?
+
+      obj[:package_details] = package_details unless package_details.empty?
+      obj
+    end
+  end
+end

data/lib/bosta/utils/utils.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+#:nodoc: all
+class Hash
+  def compact
+    delete_if { |_k, v| v.nil? }
+  end
+end

data/lib/bosta/zones/zone.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Bosta
+  ##
+  # This class represents the zones that your addresses will contain in creating deliveries and pickups.
+  class Zone
+    ##
+    # Get all zones names.
+    #
+    # Here you will find all zones that you will need to provide in
+    # creating shipments and pickups.
+    #
+    # An Error is raised if the endpoint didn't return data
+
+    def self.find_all_zones
+      Bosta::Resource.send('get', 'zones')
+    end
+
+    ##
+    # Get all zones in a specific city.
+    #
+    # +zone_id+ represents the id of the zone to be obtaines
+    #
+    # An Error is raised if the endpoint didn't return data or wrong +zone_id+ was given
+
+    def self.show_zone(zone_id)
+      Bosta::Resource.send('get', "zones/#{zone_id}")
+    end
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: bosta
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ahmad Elkhateeb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+description: |-
+  This gem simplifies the integration process with Bosta.
+    create, update and track your shimpents easily
+email: ahmed.khateeb@bosta.co
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- bosta.gemspec
+- lib/bosta.rb
+- lib/bosta/cities/city.rb
+- lib/bosta/config.rb
+- lib/bosta/deliveries/delivery.rb
+- lib/bosta/pickups/pickup.rb
+- lib/bosta/resource.rb
+- lib/bosta/utils/address.rb
+- lib/bosta/utils/bosta_object.rb
+- lib/bosta/utils/constants.rb
+- lib/bosta/utils/contact_person.rb
+- lib/bosta/utils/receiver.rb
+- lib/bosta/utils/specs.rb
+- lib/bosta/utils/utils.rb
+- lib/bosta/zones/zone.rb
+homepage: https://github.com/bostaapp/bosta-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A Ruby client SDK for Bosta APIs integration.
+test_files: []