nexus-invision 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b0350a4552d18c63a14afb7b050ce5601d30d925d61aed4a8c1d26a75c317d2
+  data.tar.gz: 8aa1f17d9fc4a5d0207fc2931b5de617c2f63b8dada69b262f1394a801d8af22
+SHA512:
+  metadata.gz: 19446aee23a1c59eae6535d691cac9c094ea33b101b4e97556882815bbff707a8cb221e01bedd307b171911e4be287a4c723f8de7b1f16118974f1e3bb8c3875
+  data.tar.gz: 3477c056719ce9264016b6b09f3647c1d98f4b917056cfa86078ca8a4dfb6258030851a0ef6153e3301ea80dc2ee71b91a4769d8b3e3b54d94be06aba87e6820

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml

data/Gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in nexus-invision.gemspec
+gemspec
+
+gem "faraday", "~> 2.7"
+gem "rake", "~> 13.0"
+gem "sorbet-runtime"
+
+group :development do
+  gem "rubocop", "~> 1.57"
+  gem "rubocop-shopify", "~> 2.14"
+  gem "sorbet"
+  gem "tapioca", require: false
+end
+
+group :test do
+  gem "rspec", "~> 3.12"
+end

data/Gemfile.lock

@@ -0,0 +1,110 @@
+PATH
+  remote: .
+  specs:
+    nexus-invision (0.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.1.1)
+    diff-lcs (1.5.0)
+    erubi (1.12.0)
+    faraday (2.7.11)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    netrc (0.11.0)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    prettier_print (1.2.1)
+    prism (0.15.1)
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rbi (0.1.2)
+      prism (>= 0.15.1)
+      sorbet-runtime (>= 0.5.9204)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.57.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-shopify (2.14.0)
+      rubocop (~> 1.51)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    sorbet (0.5.11108)
+      sorbet-static (= 0.5.11108)
+    sorbet-runtime (0.5.11108)
+    sorbet-static (0.5.11108-x86_64-linux)
+    sorbet-static-and-runtime (0.5.11108)
+      sorbet (= 0.5.11108)
+      sorbet-runtime (= 0.5.11108)
+    spoom (1.2.4)
+      erubi (>= 1.10.0)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      syntax_tree (>= 6.1.1)
+      thor (>= 0.19.2)
+    syntax_tree (6.2.0)
+      prettier_print (>= 1.2.0)
+    tapioca (0.11.9)
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (~> 0.1.0, >= 0.1.0)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      spoom (~> 1.2.0, >= 1.2.0)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.3.0)
+    unicode-display_width (2.5.0)
+    yard (0.9.34)
+    yard-sorbet (0.8.1)
+      sorbet-runtime (>= 0.5)
+      yard (>= 0.9)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  faraday (~> 2.7)
+  nexus-invision!
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  rubocop (~> 1.57)
+  rubocop-shopify (~> 2.14)
+  sorbet
+  sorbet-runtime
+  tapioca
+
+BUNDLED WITH
+   2.4.13

data/README.md

@@ -0,0 +1,55 @@
+# Invision API
+
+A client library for the Invision Community API.
+
+## Release to rubygems
+
+You must tag the commit to perform a release.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add nexus-invision
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install nexus-invision
+
+## Usage
+
+```ruby
+require "nexus/invision/client"
+
+client = Nexus::Invision::Client.build(base_url: "https://example.com/api", api_key: "secret")
+
+request = Nexus::Invision::Requests::CreateForumTopic.new(
+  forum_id: 1,
+  title: "Hello World",
+  post: "This is my first post!"
+)
+
+begin
+  topic = client.create_forum_topic(request)
+
+  puts topic.id # 1337
+rescue Nexus::Invision::Errors::BadRequest => e
+  # ...
+rescue Nexus::Invision::Errors::UnexpectedResponse => e
+  # ...
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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).
+
+Run the test suite:
+
+    $ bundle exec rspec
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at https://gitlab.nexdev.uk/nexus-mods/public/nexus-invision

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: []

data/lib/nexus/invision/client.rb

@@ -0,0 +1,177 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "faraday"
+require "nexus/invision/errors/bad_request"
+require "nexus/invision/errors/unexpected_response"
+require "nexus/invision/requests/add_member_to_secondary_group"
+require "nexus/invision/requests/create_forum_topic"
+require "nexus/invision/requests/create_member_warning"
+require "nexus/invision/requests/remove_member_from_secondary_group"
+require "nexus/invision/resources/login_link"
+require "nexus/invision/resources/topic"
+require "nexus/invision/resources/user"
+require "nexus/invision/resources/warning"
+require "sorbet-runtime"
+require "uri"
+
+module Nexus
+  module Invision
+    class HTTPMethod < T::Enum
+      enums do
+        GET = new
+        POST = new
+        DELETE = new
+      end
+    end
+
+    class Client
+      extend T::Sig
+
+      sig { params(connection: Faraday::Connection).void }
+      def initialize(connection)
+        @connection = connection
+      end
+
+      class << self
+        extend T::Sig
+
+        sig do
+          params(
+            base_url: URI::HTTP,
+            api_key: String,
+            block: T.nilable(T.proc.params(arg0: Faraday::Connection).void),
+          ).returns(Client)
+        end
+        def build(base_url:, api_key:, &block)
+          new(
+            Faraday.new(url: base_url.to_s, headers: { "Accept" => "application/json" }) do |builder|
+              builder.request(:authorization, :basic, api_key, "")
+              builder.request(:url_encoded)
+              builder.response(:json)
+              block&.call(builder)
+            end,
+          )
+        end
+      end
+
+      sig { params(request: Requests::CreateForumTopic).returns(Resources::Topic) }
+      def create_forum_topic(request)
+        response = request(
+          http_method: HTTPMethod::POST,
+          endpoint: URI("forums/topics"),
+          params: request.serialize,
+        )
+
+        Resources::Topic.from_hash(response.body)
+      end
+
+      sig { params(nexusmods_member_id: Integer).returns(Resources::LoginLink) }
+      def login_link(nexusmods_member_id)
+        response = request(
+          http_method: HTTPMethod::GET,
+          endpoint: URI("core/loginlinks/#{nexusmods_member_id}"),
+        )
+
+        Resources::LoginLink.from_hash(response.body)
+      end
+
+      sig { params(request: Requests::AddMemberToSecondaryGroup).returns(Resources::User) }
+      def add_member_to_secondary_group(request)
+        response = request(
+          http_method: HTTPMethod::POST,
+          endpoint: URI("core/members/#{request.member_id}/secgroups/#{request.group_id}"),
+        )
+
+        Resources::User.from_hash(response.body)
+      end
+
+      sig { params(request: Requests::RemoveMemberFromSecondaryGroup).returns(Resources::User) }
+      def remove_member_from_secondary_group(request)
+        response = request(
+          http_method: HTTPMethod::DELETE,
+          endpoint: URI("core/members/#{request.member_id}/secgroups/#{request.group_id}"),
+        )
+
+        Resources::User.from_hash(response.body)
+      end
+
+      sig { params(request: Requests::CreateMemberWarning).returns(Resources::Warning) }
+      def create_member_warning(request)
+        response = request(
+          http_method: HTTPMethod::POST,
+          endpoint: URI("core/members/#{request.member_id}/warnings"),
+          params: request.serialize.except("member_id"),
+        )
+
+        Resources::Warning.from_hash(response.body)
+      end
+
+      sig { params(member_id: Integer).returns(Resources::User) }
+      def ban_member(member_id)
+        response = request(
+          http_method: HTTPMethod::POST,
+          endpoint: URI("core/bans/#{member_id}"),
+        )
+
+        Resources::User.from_hash(response.body)
+      end
+
+      sig { params(member_id: Integer).returns(Resources::User) }
+      def unban_member(member_id)
+        response = request(
+          http_method: HTTPMethod::DELETE,
+          endpoint: URI("core/bans/#{member_id}"),
+        )
+
+        Resources::User.from_hash(response.body)
+      end
+
+      private
+
+      sig do
+        params(
+          http_method: HTTPMethod,
+          endpoint: URI,
+          params: T::Hash[String, T.untyped],
+        ).returns(Faraday::Response)
+      end
+      def request(http_method:, endpoint:, params: {})
+        response =
+          case http_method
+          when HTTPMethod::GET
+            @connection.get(endpoint, params)
+          when HTTPMethod::POST
+            @connection.post(endpoint, params)
+          when HTTPMethod::DELETE
+            @connection.delete(endpoint, params)
+          else
+            T.absurd(http_method)
+          end
+
+        handle_error(response) unless response.success?
+
+        response
+      end
+
+      ERROR_CODE_KEY = "errorCode"
+      ERROR_MESSAGE_KEY = "errorMessage"
+
+      sig { params(response: Faraday::Response).void }
+      def handle_error(response)
+        body = response.body
+
+        if bad_request_error?(body)
+          raise Errors::BadRequest.new(body[ERROR_MESSAGE_KEY], body[ERROR_CODE_KEY], response.env)
+        end
+
+        raise Errors::UnexpectedResponse.new("Unexpected response", response.env)
+      end
+
+      sig { params(body: Object).returns(T::Boolean) }
+      def bad_request_error?(body)
+        body.is_a?(Hash) && body.key?(ERROR_MESSAGE_KEY) && body.key?(ERROR_CODE_KEY)
+      end
+    end
+  end
+end

data/lib/nexus/invision/errors/bad_request.rb

@@ -0,0 +1,24 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "nexus/invision/errors/client_error"
+require "sorbet-runtime"
+
+module Nexus
+  module Invision
+    module Errors
+      class BadRequest < ClientError
+        extend T::Sig
+
+        sig { returns(String) }
+        attr_reader :code
+
+        sig { params(message: String, code: String, env: Faraday::Env).void }
+        def initialize(message, code, env)
+          super(message, env)
+          @code = code
+        end
+      end
+    end
+  end
+end

data/lib/nexus/invision/errors/client_error.rb

@@ -0,0 +1,23 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+
+module Nexus
+  module Invision
+    module Errors
+      class ClientError < StandardError
+        extend T::Sig
+
+        sig { returns(Faraday::Env) }
+        attr_reader :env
+
+        sig { params(message: String, env: Faraday::Env).void }
+        def initialize(message, env)
+          super(message)
+          @env = env
+        end
+      end
+    end
+  end
+end

data/lib/nexus/invision/errors/unexpected_response.rb

@@ -0,0 +1,13 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "nexus/invision/errors/client_error"
+require "sorbet-runtime"
+
+module Nexus
+  module Invision
+    module Errors
+      class UnexpectedResponse < ClientError; end
+    end
+  end
+end

data/lib/nexus/invision/requests/add_member_to_secondary_group.rb

@@ -0,0 +1,18 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "nexus/invision/value_object"
+require "sorbet-runtime"
+
+module Nexus
+  module Invision
+    module Requests
+      class AddMemberToSecondaryGroup < T::Struct
+        include ValueObject
+
+        const :member_id, Integer
+        const :group_id, Integer
+      end
+    end
+  end
+end

data/lib/nexus/invision/requests/create_forum_topic.rb

@@ -0,0 +1,22 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "nexus/invision/value_object"
+require "sorbet-runtime"
+
+module Nexus
+  module Invision
+    module Requests
+      class CreateForumTopic < T::Struct
+        include ValueObject
+
+        const :forum_id, Integer
+        const :title, String
+        const :post, String
+        const :author, T.nilable(Integer)
+        const :close_time, T.nilable(Time)
+        const :prefix, T.nilable(String)
+      end
+    end
+  end
+end

data/lib/nexus/invision/requests/create_member_warning.rb

@@ -0,0 +1,22 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "nexus/invision/value_object"
+require "sorbet-runtime"
+
+module Nexus
+  module Invision
+    module Requests
+      class CreateMemberWarning < T::Struct
+        include ValueObject
+
+        const :member_id, Integer
+        const :moderator, T.nilable(Integer)
+        const :reason, T.nilable(Integer)
+        const :acknowledged, T.nilable(T::Boolean)
+        const :suspend, T.nilable(T.any(Time, Integer))
+        const :member_note, T.nilable(String), name: "memberNote"
+      end
+    end
+  end
+end

data/lib/nexus/invision/requests/remove_member_from_secondary_group.rb

@@ -0,0 +1,18 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "nexus/invision/value_object"
+require "sorbet-runtime"
+
+module Nexus
+  module Invision
+    module Requests
+      class RemoveMemberFromSecondaryGroup < T::Struct
+        include ValueObject
+
+        const :member_id, Integer
+        const :group_id, Integer
+      end
+    end
+  end
+end

data/lib/nexus/invision/resources/login_link.rb

@@ -0,0 +1,17 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "nexus/invision/value_object"
+require "sorbet-runtime"
+
+module Nexus
+  module Invision
+    module Resources
+      class LoginLink < T::Struct
+        include ValueObject
+
+        const :id, Integer
+      end
+    end
+  end
+end

data/lib/nexus/invision/resources/topic.rb

@@ -0,0 +1,17 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "nexus/invision/value_object"
+require "sorbet-runtime"
+
+module Nexus
+  module Invision
+    module Resources
+      class Topic < T::Struct
+        include ValueObject
+
+        const :id, Integer
+      end
+    end
+  end
+end

data/lib/nexus/invision/resources/user.rb

@@ -0,0 +1,17 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "nexus/invision/value_object"
+require "sorbet-runtime"
+
+module Nexus
+  module Invision
+    module Resources
+      class User < T::Struct
+        include ValueObject
+
+        const :id, Integer
+      end
+    end
+  end
+end

data/lib/nexus/invision/resources/warning.rb

@@ -0,0 +1,17 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "nexus/invision/value_object"
+require "sorbet-runtime"
+
+module Nexus
+  module Invision
+    module Resources
+      class Warning < T::Struct
+        include ValueObject
+
+        const :id, Integer
+      end
+    end
+  end
+end

data/lib/nexus/invision/value_object.rb

@@ -0,0 +1,28 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+
+module Nexus
+  module Invision
+    module ValueObject
+      extend T::Sig
+      extend T::Helpers
+
+      abstract!
+
+      sig { abstract.returns(T::Class[ValueObject]) }
+      def class; end
+
+      sig { abstract.returns(T::Hash[String, T.untyped]) }
+      def serialize; end
+
+      sig { params(other: ValueObject).returns(T::Boolean) }
+      def eql?(other)
+        self.class == other.class && serialize == other.serialize
+      end
+
+      alias_method :==, :eql?
+    end
+  end
+end

data/lib/nexus/invision/version.rb

@@ -0,0 +1,9 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Nexus
+  module Invision
+    # Leave this as 1.0.0 in order for CI process to replace with the tagged version.
+    VERSION = "1.0.0"
+  end
+end

data/nexus-invision.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/nexus/invision/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "nexus-invision"
+  spec.version = Nexus::Invision::VERSION
+  spec.authors = ["Jack Robertson"]
+  spec.email = ["jack.robertson@nexusmods.com"]
+
+  spec.summary = "A client for the Invision Community REST API."
+  spec.homepage = "https://gitlab.nexdev.uk/nexus-mods/public/nexus-invision"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    %x(git ls-files -z).split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(
+        "bin/",
+        "test/",
+        "spec/",
+        "features/",
+        ".git",
+        ".circleci",
+        "appveyor",
+      )
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/sorbet/config

@@ -0,0 +1,4 @@
+--dir
+.
+--ignore=tmp/
+--ignore=vendor/

data/sorbet/rbi/annotations/.gitattributes

@@ -0,0 +1 @@
+**/*.rbi linguist-vendored=true