devme-sdk-ruby 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae34a3e792367f426e1985eb3443dd92a8e69a156bd5cb22777df4407d66bbee
+  data.tar.gz: db7c44b8008694d8563a31ffdbf08346e74d8680d6ed70dcb28e49b8f5df0763
+SHA512:
+  metadata.gz: 31fffcfc3aaee68ac47834caf63ed697842b6029173ce1496afa752a0662172924df02b5b4e0fedbb8f70f925ceae929d983b59614b362d0926b9501aba9e1f8
+  data.tar.gz: 651ab46fde5d3918da231e823093b473e180e82764362bcd31f8b91be92ae5a8e832855e9ca12112446dedaa6c005b48033ab8e5e19e9c091c0fd4574c59c8bf

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Change Log
+
+## v1.0.0
+- Initial stable release
+- Adding tests
+- Adding documentation
+- Adding examples
+- Adding examples to README.md

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.93.0'
+end

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    devme-sdk-ruby (1.0.1)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    ethon (0.15.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.5)
+    method_source (1.0.0)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  devme-sdk-ruby!
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.93.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.md

@@ -0,0 +1,25 @@
+The MIT License (MIT)
+=====================
+
+Copyright © `2021` `DEV.ME`
+
+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
+NON INFRINGEMENT. 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,97 @@
+# DEV.ME SDK for Ruby
+
+[![Build Status](https://github.com/devmehq/devme-sdk-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/devmehq/devme-sdk-ruby/actions/workflows/ci.yml)
+[![Gem Version](https://img.shields.io/gem/v/devme-sdk-ruby)](https://rubygems.org/gems/devme-sdk-ruby)
+[![Downloads](https://img.shields.io/gem/dt/devme-sdk-ruby)](https://rubygems.org/gems/devme-sdk-ruby)
+
+DEV.ME SDK for Ruby
+
+> Compatible with Ruby on Rails
+
+## Get Your Free API Key
+
+[Signup Here](https://dev.me/signup) and Get Your Free API Key
+
+## Installation and usage instructions
+
+## Installation
+
+Install the module through GEM:
+
+```shell
+gem install devme-sdk-ruby
+```
+
+Or GEMFILE:
+
+```shell
+gem "devme-sdk-ruby", "~> 1.0"
+```
+
+## Examples
+
+### Currency API Conversion
+
+```ruby
+require 'devme-sdk-ruby'
+DevmeSdk.configure do |config|
+  config.api_key['APIKeyHeader'] = 'demo-key'
+end
+@api_instance = DevmeSdk::CurrencyApi.new
+result = @api_instance.v1_convert_currency(from = 'USD', to = 'EUR', opts = { amount: 10 })
+# puts result
+# {
+#   convertedAmount: 8.819,
+#   convertedText: '10 USD equal to 8.819 EUR',
+#   exchangeRate: 0.8819,
+#   from: 'USD',
+#   originalAmount: 10,
+#   rateTime: '2022-01-20T14:49:28.046Z',
+#   to: 'EUR'
+# }
+```
+
+### IP API Geolocation, IP2Location, IP Data
+
+```ruby
+require 'devme-sdk-ruby'
+DevmeSdk.configure do |config|
+  config.api_key['APIKeyHeader'] = 'demo-key'
+end
+@api_instance = DevmeSdk::IPApi.new
+result = @api_instance.v1_get_ip_details(opts = { ip: '52.45.23.11' })
+
+# {
+#   asn: 14618,
+#   aso: 'AMAZON-AES',
+#   city: {
+#   accuracyRadius: 1000,
+#     latitude: 39.0469,
+#     longitude: -77.4903,
+#     metroCode: 511,
+#     name: 'Ashburn',
+#     timeZone: 'America/New_York',
+#   },
+#   countryCode: 'US',
+#   ip: '52.45.23.11',
+#   registeredCountryCode: 'US',
+# }
+
+```
+
+## Testing
+
+```shell
+bundle exec rake
+```
+
+## Need Help?
+
+If you need help please drop us a message, we would be glad to help @ [Contact us](http://dev.me/contact-us)
+
+## Contributing
+
+Please feel free to open an issue or create a pull request and fix bugs or add features, All contributions are welcome.
+Thank you!
+
+## LICENSE [MIT](LICENSE.md)

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/devme-sdk-ruby.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#DEV.ME API Documentation
+
+#DEV.ME API Documentation [Currency Conversion and Exchange Rates API](https://dev.me/products/currency) - [IP2Location, IP Country, IP Information API](https://dev.me/products/ip) -  [Email Validation, Mailbox Verification](https://dev.me/products/email) - [Phone Number Validation](https://dev.me/products/phone). You can learn more at [dev.me](https://dev.me). For this example you can use api key `demo-key` to test the APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@dev.me
+
+
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "devme-sdk-ruby/version"
+
+Gem::Specification.new do |s|
+  s.name        = "devme-sdk-ruby"
+  s.version     = DevmeSdk::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["DEV.ME Team"]
+  s.email       = ["support@dev.me"]
+  s.homepage    = "https://github.com/devmehq/devme-sdk-ruby"
+  s.summary     = "DEV.ME SDK for Ruby"
+  s.description = "DEV.ME API Documentation [Currency Conversion and Exchange Rates API](https://dev.me/products/currency) - [IP2Location, IP Country, IP Information API](https://dev.me/products/ip) -  [Email Validation, Mailbox Verification](https://dev.me/products/email) - [Phone Number Validation](https://dev.me/products/phone). You can learn more at [dev.me](https://dev.me). For this example you can use api key `demo-key` to test the APIs"
+  s.license     = "MIT"
+  s.required_ruby_version = ">= 2.4"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/examples/app/.gitignore

@@ -0,0 +1,198 @@
+### Windows template
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+### Node template
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+### macOS template
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Ignore all the yarn.lock files except the one at root
+yarn.lock
+!/yarn.lock
+
+.idea
+dist
+/sdk/src
+
+.env.*
+/sdk/
+package-lock.json
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+test.rb
+vendor/
+devme-sdk-ruby*.gem

data/examples/app/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "colorize", "~> 0.8.1"
+gem "devme-sdk-ruby", "~> 1.0"
+gem "rainbow", "~> 3.1"
+

data/examples/app/Gemfile.lock

@@ -0,0 +1,23 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.8.1)
+    devme-sdk-ruby (1.0.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+    ethon (0.15.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.5)
+    rainbow (3.1.1)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  colorize (~> 0.8.1)
+  devme-sdk-ruby (~> 1.0)
+  rainbow (~> 3.1)
+
+BUNDLED WITH
+   1.17.2

data/examples/app/test-api.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'devme-sdk-ruby'
+require 'colorize'
+require 'rainbow'
+
+puts Rainbow('This will be printed in red').red
+puts "Hello, world!".colorize(:red)
+
+DevmeSdk.configure do |config|
+  config.api_key['APIKeyHeader'] = 'demo-key'
+end
+@api_instance = DevmeSdk::CurrencyApi.new
+result = @api_instance.v1_convert_currency(from = 'USD', to = 'EUR', opts = { amount: 10 })
+puts result
+
+@api_instance = DevmeSdk::IPApi.new
+result = @api_instance.v1_get_ip_details(opts = { ip: '52.45.23.11' })
+puts result