luminati-ruby 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 29c41473dacef780c406525ebdf44c9fd12e369969f30d38c088fb1e9d9aa6b7
+  data.tar.gz: 5eaf07fa086cbc8d332cdbec57e60358152afab98925f93b72531b2ff48d5b89
+SHA512:
+  metadata.gz: 2177ca10a6ae3db31f46f5c624302e9a9d4af3baccf0cd380c9c237d5c3c58a5df76fc3994dc825b7161048b149fe115ff7ef91d0bfd5432d67db255c4632d44
+  data.tar.gz: 2806323cc6eb8fa966178c225302e097be41a7d056335cbd4dabd73a7d825eade1df7557dcd46b8347f8e325225d35d68816c458b72c37dc78051a341408f7d3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 doublemarket
+
+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,61 @@
+# luminati-ruby
+
+A Ruby interface to the [Luminati API](https://luminati.io/doc/api).
+
+**Caution: This gem currently supports only selected endpoints of the existing API.** Those are missing:
+
+- Some endpoints of [the Account management API](https://luminati.io/doc/api#account_api).
+- [Proxy Manager API](https://luminati.io/doc/api#lpm_endpoints)
+
+Check out the [documentation](https://rubydoc.info/gems/luminati-ruby) for which ones are supported.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'luminati-ruby'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install luminati-ruby
+```
+
+## Usage
+
+Get `Luminati::Client` by calling `Luminati::Client.new` with an API token. You can get your API token via https://luminati.io/cp/setting.
+
+```
+client = Luminati::Client.new("your api token")
+```
+
+and call any methods you want to use:
+
+```
+client.active_zones
+=> [{"name"=>"testzone01", "type"=>"dc"}]
+```
+
+Also refer to the documentation https://rubydoc.info/gems/luminati-ruby
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/doublemarket/luminati-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/luminati/client/customer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Luminati
+  class Client
+    module Customer
+      # Returns the bandwidth stats for all your zones.
+      # @see https://luminati.io/doc/api#stats_api_bw_cust
+      # @param from [String] This should be in the format `2018-07-01T00:00:00`.
+      # @param to [String] This should be in the format `2018-07-02T00:00:00`.
+      # @return [Hash]
+      def customer_bandwidth_stats(from = nil, to = nil)
+        parameters = "details=1"
+        parameters << "&from=#{from}" if from
+        parameters << "&to=#{to}" if to
+        request(:get, "/api/customer/bw?#{parameters}")
+      end
+
+      # Returns the total balance of your account.
+      # @see https://luminati.io/doc/api#account_api_balance
+      # @return [Hash]
+      def customer_balance
+        request(:get, "/api/customer/balance")
+      end
+    end
+  end
+end

data/lib/luminati/client/zone/ips.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Luminati
+  class Client
+    module Zone
+      module Ips
+        # Returns datacenter IPs for a given zone.
+        # @see https://luminati.io/doc/api#account_api_zone_datacenter_ips
+        # @param zone_name [String]
+        # @param ip_per_country [Boolean] `true` when you want to get a total amount of IPs per country
+        # @return [Hash]
+        def zone_ips(zone_name, ip_per_country = false)
+          parameters = "zone=#{zone_name}"
+          parameters << "&ip_per_country" if ip_per_country
+          request(:get, "/api/zone/ips?#{parameters}")
+        end
+
+        # Returns zones and IPs with connectivity issues.
+        # @see https://luminati.io/doc/api#allocated_unavailable_ips
+        # @return [Hash] When there's no zones that has issues, this should be `{}`.
+        def unavailable_zones_ips
+          request(:get, "/api/zone/ips/unavailable")
+        end
+
+        # Add IPs to a given zone
+        # @see https://luminati.io/doc/api#account_api_add_ips
+        # @param ip_info [Hash]
+        # @return [Hash] Added IPs information
+        def add_ips(ip_info)
+          data = ip_info
+          request(:post, "/api/zone/ips", Oj.dump(data, mode: :compat))
+        end
+
+        # Remove Ips from a given zone
+        # @see https://luminati.io/doc/api#account_api_remove_ips
+        # @param zone_name [String]
+        # @param ips [Array] An array of IPs
+        # @return [Hash]
+        def remove_ips(zone_name, ips)
+          data = {}
+          data["zone"] = zone_name
+          data["ips"] = ips
+          request(:delete, "/api/zone/ips", Oj.dump(data, mode: :compat))
+        end
+      end
+    end
+  end
+end

data/lib/luminati/client/zone.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module Luminati
+  class Client
+    module Zone
+      # Returns the bandwidth stats for a given zone
+      # @see https://luminati.io/doc/api#stats_api_bw_zone
+      # @param zone_name [String]
+      # @param from [String] This should be in the format `2018-07-01T00:00:00`.
+      # @param to [String] This should be in the format `2018-07-02T00:00:00`.
+      # @return [Hash]
+      def zone_bandwidth_stats(zone_name, from = nil, to = nil)
+        parameters = "zone=#{zone_name}&details=1"
+        parameters << "&from=#{from}" if from
+        parameters << "&to=#{to}" if to
+        request(:get, "/api/zone/bw?#{parameters}")
+      end
+
+      # Returns the cost and the bandwidth stats for a given zone
+      # @see https://luminati.io/doc/api#stats_api_cost_zone
+      # @param zone_name [String]
+      # @param from [String] This should be in the format `2018-07-01T00:00:00`.
+      # @param to [String] This should be in the format `2018-07-02T00:00:00`.
+      # @return [Hash]
+      def zone_cost_stats(zone_name, from = nil, to = nil)
+        parameters = "zone=#{zone_name}"
+        parameters << "&from=#{from}" if from
+        parameters << "&to=#{to}" if to
+        request(:get, "/api/zone/cost?#{parameters}")
+      end
+
+      # Returns the number of available IPs
+      # @see https://luminati.io/doc/api#account_api_count_available_ips
+      # @param zone_name [String]
+      # @param plan [Hash]
+      # @return [Hash]
+      def zone_available_ip_count(zone_name, plan = nil)
+        parameters = "zone=#{zone_name}"
+        parameters << "&plan=#{Oj.dump(plan, mode: :compat)}" if plan
+        request(:get, "/api/zone/count_available_ips?#{parameters}")
+      end
+
+      # Returns recent IPs attempting to use a given zone
+      # @see https://luminati.io/doc/api#ip_mgmnt_api_ip_attempt
+      # @param zone_names [String] `*` or zone names separated with `,`
+      # @return [Hash]
+      def zone_recent_ips(zone_names)
+        parameters = "zones=#{zone_names}"
+        request(:get, "/api/zone/recent_ips?#{parameters}")
+      end
+
+      # Returns avaialble IPs in a given zone and a given country
+      # @see https://luminati.io/doc/api#ip_mgmnt_ips_country_dc
+      # @param zone_name [String]
+      # @param country_code [String] A country code like `US`.
+      # @param expand [Boolean] `true` when you want expanded IPs
+      # @return [Hash]
+      def zone_available_ips(zone_name, country_code = nil, expand = false)
+        parameters = "zone=#{zone_name}"
+        parameters << "&country=#{country_code}" if country_code
+        parameters << "&expand=1" if expand
+        request(:get, "/api/zone/route_ips?#{parameters}")
+      end
+
+      # Returns available VIPs in a given zone
+      # @see https://luminati.io/doc/api#ip_mgmnt_gips
+      # @param zone_name [String]
+      # @return [Hash]
+      def zone_available_vips(zone_name)
+        parameters = "zone=#{zone_name}"
+        request(:get, "/api/zone/route_vips?#{parameters}")
+      end
+
+      # Returns the information of a given zone
+      # @see https://luminati.io/doc/api#account_api_get_zone
+      # @param zone_name [String]
+      # @return [Hash]
+      def zone_info(zone_name)
+        parameters = "zone=#{zone_name}"
+        request(:get, "/api/zone?#{parameters}")
+      end
+
+      # Adds a zone
+      # @see https://luminati.io/doc/api#account_api_add_zone
+      # @param zone_info [Hash]
+      # @param plan_info [Hash]
+      # @return [String] The official API documentation says it returns the information of the added zone but currently it returns just `OK`.
+      def add_zone(zone_info, plan_info)
+        data = {}
+        data["zone"] = zone_info unless zone_info.empty?
+        data["plan"] = plan_info unless plan_info.empty?
+        request(:post, "/api/zone", Oj.dump(data, mode: :compat))
+      end
+
+      # Remove a zone
+      # @see https://luminati.io/doc/api#account_api_remove_zone
+      # @param zone_name [String]
+      # @return [String] The official API documentation says it returns the information of the added zone but currently it returns just `OK`.
+      def remove_zone(zone_name)
+        data = {}
+        data["zone"] = zone_name
+        request(:delete, "/api/zone", Oj.dump(data, mode: :compat))
+      end
+
+      # Returns passwords of a given zone
+      # @see https://luminati.io/doc/api#account_api_zone_passwords
+      # @param zone_name [String]
+      # @returns [Hash]
+      def zone_passwords(zone_name)
+        parameters = "zone=#{zone_name}"
+        request(:get, "/api/zone/passwords?#{parameters}")
+      end
+
+      # Returns permissions of a given zone
+      # @see https://luminati.io/doc/api#account_api_zone_perms
+      # @param zone_name [String]
+      # @returns [Hash]
+      def zone_permissions(zone_name)
+        parameters = "zone=#{zone_name}"
+        request(:get, "/api/zone/permissions?#{parameters}")
+      end
+
+      # Returns the status of a given zone
+      # @see https://luminati.io/doc/api#account_api_zone_status
+      # @param zone_name [String]
+      # @returns [Hash]
+      def zone_status(zone_name)
+        parameters = "zone=#{zone_name}"
+        request(:get, "/api/zone/status?#{parameters}")
+      end
+
+      # Returns active zones
+      # @see https://luminati.io/doc/api#account_api_get_active_zones
+      # @returns [Hash]
+      def active_zones
+        request(:get, "/api/zone/get_active_zones")
+      end
+    end
+  end
+end

data/lib/luminati/client.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "luminati/client/zone"
+require "luminati/client/zone/ips"
+require "luminati/client/customer"
+
+module Luminati
+  class Client
+    include Luminati::Client::Zone
+    include Luminati::Client::Zone::Ips
+    include Luminati::Client::Customer
+
+    API_URL = "https://luminati.io"
+
+    attr_accessor :api_token
+
+    # Initializes a new Client object.
+    # @param api_token [String]
+    # @return [Luminati::Client]
+    def initialize(api_token = nil)
+      instance_variable_set("@api_token", api_token) if api_token
+    end
+
+    # Returns the current service status for a given network type
+    # @see https://luminati.io/doc/api#account_api_stat
+    # @param network_type [Symbol] A network type, one of `:all`, `:res`, `:dc`, `:mobile`.
+    # @return [Hash]
+    def network_status(network_type = :all)
+      request(:get, "/api/network_status/#{network_type}")
+    end
+
+    # Returns cities for a given country
+    # @see https://luminati.io/doc/api#others_get_cities
+    # @param country_code [String] A country code like `US`.
+    # @return [Hash]
+    def cities(country_code)
+      request(:get, "/api/cities?country=#{country_code}")
+    end
+
+    private
+
+    def conn
+      headers = {
+        "Content-Type": "application/json"
+      }
+      headers = headers.merge({ "Authorization": "Bearer #{@api_token}" }) if @api_token
+      @conn ||= Faraday.new(
+        API_URL,
+        request: { timeout: 5 },
+        headers: headers
+      )
+    end
+
+    def request(method, path, options = nil)
+      res = if method == :delete
+              conn.delete(path) { |req| req.body = options }
+            else
+              conn.public_send(method, path, options)
+            end
+      if res.status == 200
+        begin
+          Oj.load(res.body)
+        rescue Oj::ParseError
+          # when the body isn't JSON (e.g. GET /api/zone/route_ips)
+          res.body
+        end
+      else
+        { "status_code" => res.status, "status_message" => res.reason_phrase, "response_body" => res.body }
+      end
+    end
+  end
+end

data/lib/luminati/version.rb

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

data/lib/luminati.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "oj"
+require_relative "luminati/version"
+require_relative "luminati/client"

data/luminati-ruby.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "lib/luminati/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "luminati-ruby"
+  spec.version       = Luminati::VERSION
+  spec.authors       = ["doublemarket"]
+  spec.email         = ["doublemarket@gmail.com"]
+
+  spec.description   = "A Ruby interface to the Luminati API"
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/doublemarket/luminati-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/doublemarket/luminati-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/doublemarket/luminati-ruby"
+
+  spec.files = %w[LICENSE.txt README.md luminati-ruby.gemspec] + Dir["lib/**/*.rb"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 1.0"
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: luminati-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- doublemarket
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A Ruby interface to the Luminati API
+email:
+- doublemarket@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/luminati.rb
+- lib/luminati/client.rb
+- lib/luminati/client/customer.rb
+- lib/luminati/client/proxies.rb
+- lib/luminati/client/zone.rb
+- lib/luminati/client/zone/ips.rb
+- lib/luminati/version.rb
+- luminati-ruby.gemspec
+homepage: https://github.com/doublemarket/luminati-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/doublemarket/luminati-ruby
+  source_code_uri: https://github.com/doublemarket/luminati-ruby
+  changelog_uri: https://github.com/doublemarket/luminati-ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: A Ruby interface to the Luminati API
+test_files: []