planethoster_api 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39be460ddd5c0d501bcb7005bc23cac9b34d4c27147290bfb5e37838c821616e
-  data.tar.gz: 6bfe7a4645f194eefb2aaef31e991c03fadc00aecd744c42aa08ed51745f7447
+  metadata.gz: 68170f22305923e2c10038e03dac0653802223c0546b6e4d263574d1956f9271
+  data.tar.gz: ce0d009dacffe0013904640f11f2137157755114f79c316d69f5f302f92e23ca
 SHA512:
-  metadata.gz: 7fac42b0316140cd07b312b4fc15ad2d2500b022e1fb061606f0db38feb16c24934fd988c8b86f10bf795e66105e39b3e1cd7b900e63041685a0a1a698d6a7cd
-  data.tar.gz: 4bd1daa9336394818d74cb19b51e838156fe6ce7a8852b9389067cba589d720b283f26f6351f401205b62107a5cb2f121c21412e4819224043d803778723b39b
+  metadata.gz: f1cddc8e0e9d0d2d13c3730c0f8112c22160d5b2d0fd39fb9587667b434fc2eb48e58c590ca51c2b12311711fbd825fc6b986e0dd9723fbe9d7878a2235e4e8d
+  data.tar.gz: 5856db0f347394e55c34c2253dde6c5e5949ea0ca064ad5231a73d3e28749b56085e6193c04bca5dfb1817b02b09805431d4ed8d488fb81ae91932eaa4e7d078

data/README.md

@@ -1,8 +1,13 @@
+![Gem](https://img.shields.io/gem/v/planethoster_api.svg)
 [![Build Status](https://travis-ci.org/PlanetHoster/planethoster-node.svg?branch=master)](https://travis-ci.org/PlanetHoster/planethoster-node)
+![Gem](https://img.shields.io/gem/dt/planethoster_api.svg)
 
 # Planethoster-ruby
 
-PlanetHoster API gem is a work in progess
+PlanetHoster API wrapper
+
+Please refer to the documentation of the [PlanetHoster API](https://apidoc.planethoster.com/) for all calls explanation.
+
 
 ## Installation
 
@@ -22,7 +27,61 @@ Or install it yourself as:
 
 ## Usage
 
-TODO
+You need to initialize api credentials.
+```ruby
+require 'planethoster_api'
+
+PlanethosterApi.configuration do |config|
+    config.api_user = API_USER
+    config.api_key = API_KEY
+end
+```
+
+Then, you can test api connection with this code
+```ruby
+PlanethosterApi.domain.test_connection
+```
+
+## Possible functions
+
+Make sure to checkout documentation for specific parameters and more explanation [ApiDoc](https://apidoc.planethoster.com/)
+
+### Domain
+```ruby
+PlanethosterApi.domain[...] # options down below
+```
+```ruby
+.tld_prices() # Returns domain name prices for registration, renewal and transfer.
+.account_info() # Returns information pertinent to your reseller account. (active doamin, credit left, etc..)
+.check_availability() # Checks whether a domain name is available to register.
+.domain_info() # Retrieve information for a domain which you successfully registered or created a transfer order.
+.get_contact_details() # Returns the contact information (WHOIS information) for the active domain name.
+.get_nameservers() # Returns the nameservers for a registered domain name.
+.get_ph_dns_records() # Retrieves the DNS records for the active domain name registered with PlanetHoster.
+.get_registrar_lock() # Get the lock status of a registered domain name.
+.save_contact_details() # Saves the contact information (WHOIS information) for the given active domain name.
+.save_nameservers() # Update nameservers associated with your domain.
+.save_ph_dns_records() # Saves the DNS records for the active domain name registered with PlanetHoster.
+.save_registrar_lock() # Lock or unlock a registered and active domain name.
+.email_epp_code() # Email the domain name registrant their EPP code (also called Auth Info) for the given domain.
+.register_domain() # Attempts to register a domain name for 1 to 10 years.
+.renew_domain() # Renew an already active domain name for 1-10 years.
+.transfer_domain() # Transfer a domain name from your current registrar to PlanetHoster.
+.delete_ph_dns_zone() # Deletes the DNS zone on the PlanetHoster DNS servers for the given domain.
+```
+### World (Hosting)
+[What is a world hosting?](https://www.planethoster.com/en/World-Hosting)
+```ruby
+PlanethosterApi.world[...] # options down below
+```
+```ruby
+.get_accounts() # Displays The World account and all World sub accounts information.
+.create_account() # Creates a world hosting account, assigns the requested resources and install a CMS
+.suspend_account() # Proceed to the suspension of a World account.
+.unsuspend_account() # Reactivate suspended world account.
+.modify_ressources() # Modify the resources associated with a World account.
+.upgrade_plan() # Increases resources associated with The World account.
+```
 
 ## Development
 
@@ -30,7 +89,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/PlanetHoster/planethoster-ruby/issues.
+Bug reports are welcome on GitHub at https://github.com/PlanetHoster/planethoster-ruby/issues.
 
 ## License
 

data/lib/planethoster_api.rb

@@ -39,6 +39,7 @@ module PlanethosterApi
     end
   end
 
+  private
   def self.creds_wrap
     if @configuration.nil?
       raise "api_key and api_user are not defined - Please refer to documentation and configure credentials: https://github.com/PlanetHoster/planethoster-ruby"

data/lib/planethoster_api/domain.rb

@@ -16,7 +16,7 @@ module PlanethosterApi
       save_nameservers: [:post, '/save-nameservers'],
       save_ph_dns_records: [:post, '/save-ph-dns-records'],
       save_registrar_lock: [:post, '/save-registrar-lock'],
-      email_epp_copde: [:post, '/email-epp-code'],
+      email_epp_code: [:post, '/email-epp-code'],
       register_domain: [:post, '/register-domain'],
       renew_domain: [:post, '/renew-domain'],
       transfer_domain: [:post, '/transfer-domain'],

data/lib/planethoster_api/version.rb

@@ -1,3 +1,3 @@
 module PlanethosterApi
-  VERSION = "0.0.3"
+  VERSION = "1.0.0"
 end

data/lib/utilities/api_client.rb

@@ -8,8 +8,8 @@ module Utilities
     
     def initialize(api_user, api_key)
       @headers = {
-        'X_API_USER': api_user,
-        'X_API_KEY': api_key,
+        'X-API-USER': api_user,
+        'X-API-KEY': api_key,
         'content-type': 'text/json'
       }
       @uri = nil

data/planethoster_api.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: planethoster_api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - marcandreg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-14 00:00:00.000000000 Z
+date: 2020-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -98,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: PlanetHoster API wrapper