userapi-ai 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8e731075ee42254e2b5449b12c471ad38ec7b17f49ed35c27e1f8b9cb3ab994
+  data.tar.gz: 5649910f890faa5412886612a3a615e0e6dcfeead93a874d2bc8d018082f6f60
+SHA512:
+  metadata.gz: b5f8753fb545c528159d891f6164adeac1a2aab4f76679c8893a73fe27c9eec19a9d406c7c22c7e3c114d5438e36f60cac32648b17aa98724f63081e96e5ee88
+  data.tar.gz: c7f0caef35c18a90a87c9747d85c0de3cec320ef9796de7946d20789ceffafc376794f2316c15786ef12bd9a255a55893f2cd7e18e5352f8179ceefa2d486f08

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-03-24
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at smolev@me.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Smolev Denis
+
+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,108 @@
+# Midjourney Ruby
+
+[![Gem Version](https://badge.fury.io/rb/userapi-ai.svg)](https://badge.fury.io/rb/userapi-ai)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/neonix20b/userapi-ai/blob/main/LICENSE.txt)
+
+Userapi.ai is an awesome tool that brings great value to products.
+This gem was created to facilitate Ruby and also Rails applications to use all services of Userapi.ai:
+  - Midjourney
+
+## Installation
+
+Add the following to your Gemfile:
+
+```ruby
+gem "userapi-ai"
+```
+
+Or install with:
+
+```shell
+gem install userapi-ai
+```
+
+and require with:
+
+```ruby
+require "userapi-ai"
+```
+
+Run `bundle install`.
+
+That's it. You are now ready to go!
+
+## Usage
+
+Make sure you have a
+  - Discord Account or create one at [Discord](https://discord.com)
+  - A Midjourney account or sign up at [Midjourney](https://www.midjourney.com)
+  - A Midjourney Paid plan to use this gem or sign up at [Midjourney Plans](https://www.midjourney.com/account/)
+  - A Userapi.ai Paid plan at [Userapi.ai](https://userapi.ai/)
+
+After signing in, you can get your Discord token by checking out any message request you send in the browser.
+You can do this by opening the developer tools in your browser and going to the network tab.
+Then send a message in any channel and look for the request to `messages` in the network tab.
+Check out the Request Headers and look for the `authorization` header. Copy the value of the header and use it as your Discord User Tokens.
+
+### Configuration
+
+Once you have your Userapi.ai Token, you can configure the gem with:
+
+Open up the initializer file `config/initializers/userapi.rb` and add your API Key as the following:
+
+```ruby
+  UserapiAi.configure do |config|
+    config.access_token = ENV["USERAPI_USER_TOKEN"]
+  end
+```
+
+### Imagine
+
+Imagine is a Midjourney command that allows you to use AI to generate images.
+You can use it to generate images of people, animals, objects, and anything else you can imagine.
+
+#### Basic Usage
+
+#### Using the /imagine command
+
+```ruby
+    client = UserapiAi::Client.new(service: :midjourney)
+    result = client.imagine(prompt: "nice girl")
+    or
+    result = client.imagine(prompt: "nice girl",
+                            webhook_url: "https://example.com/imagine/webhook-url",
+                            webhook_type: "progress", # or result
+                            account_hash: "a7d44910-88a6-4673-acc8-d60ffc3479a6",
+                            is_disable_prefilter: false)
+    then
+    client.status(result)
+```
+
+#### Examples of other commands with parameters
+
+```ruby
+    client = UserapiAi::Client.new(service: :midjourney)
+    result = client.status(hash: "xxx-xxx")
+    result = client.variation(hash: "xxx-xxx", choice: 1)
+    result = client.upsample(hash: "xxx-xxx", choice: "v6_2x_subtle")
+
+    result = client.upscale(hash: "xxx-xxx", 
+                            choice: 1,
+                            webhook_url:  "https://example.com/upscale/webhook-url",
+                            webhook_type: "result")
+```
+See more [here](https://butternut-saffron-e5e.notion.site/Midjourney-userapi-ai-doc-en-119680339b0a47e2ba6ae467eca58142#9abe719bb58948039acb5f0a6aee8947)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [Open an Issue](https://github.com/neonix20b/userapi-ai).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Feel free to use it and contribute.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/ruby/userapi-ai.rb

@@ -0,0 +1,2 @@
+require_relative "../userapi"
+require_relative "../userapi/compatibility"

data/lib/userapi/client.rb

@@ -0,0 +1,31 @@
+module UserapiAi
+  class Client
+    extend UserapiAi::HTTP
+
+    SERVICES = {
+      midjourney: {
+        get: [:status],
+        post: [:imagine, :describe, :upscale, :upsample, :variation, :inpaint, :blend, :reroll, :zoom, :pan, :info]
+      }
+    }
+
+    def initialize(access_token: nil, uri_base: nil, request_timeout: nil, service: nil, extra_headers: {})
+      UserapiAi.configuration.access_token = access_token if access_token
+      UserapiAi.configuration.uri_base = uri_base if uri_base
+      UserapiAi.configuration.request_timeout = request_timeout if request_timeout
+      UserapiAi.configuration.extra_headers = extra_headers
+      UserapiAi.configuration.service = service if service
+
+      SERVICES[service].each do |http_method, actions|
+        actions.each do |action|
+          method_name = action
+          method_name = "#{http_method}_#{action}" if methods.include? method_name.to_sym
+          define_singleton_method method_name.to_sym do |parameters|
+            UserapiAi::Client.public_send("json_#{http_method}", path: action, parameters: parameters)
+          end
+        end
+      end
+      
+    end
+  end
+end

data/lib/userapi/compatibility.rb

@@ -0,0 +1,9 @@
+module Ruby
+  module UserapiAi
+    VERSION = ::UserapiAi::VERSION
+
+    Error = ::UserapiAi::Error
+    ConfigurationError = ::UserapiAi::ConfigurationError
+    Configuration = ::UserapiAi::Configuration
+  end
+end

data/lib/userapi/http.rb

@@ -0,0 +1,61 @@
+module UserapiAi
+  module HTTP
+    def json_get(path:, parameters: {})
+      to_json(conn.get(uri(path: path, parameters: parameters)) do |req|
+        req.headers = headers
+      end&.body)
+    end
+
+    def json_post(path:, parameters:)
+      puts uri(path: path)
+      puts headers
+      puts parameters.to_json
+      to_json(conn.post(uri(path: path)) do |req|
+        req.headers = headers
+        req.body = parameters.to_json
+      end&.body)
+    end
+
+    #private
+
+    def to_json(string)
+      return unless string
+
+      JSON.parse(string)
+    rescue JSON::ParserError
+      # Convert a multiline string of JSON objects to a JSON array.
+      JSON.parse(string.gsub("}\n{", "},{").prepend("[").concat("]"))
+    end
+
+    def conn(multipart: false)
+      Faraday.new do |f|
+        f.options[:timeout] = UserapiAi.configuration.request_timeout
+        f.request(:multipart) if multipart
+      end
+    end
+
+    def uri(path:, parameters: {})
+      str = "#{UserapiAi.configuration.uri_base}/#{UserapiAi.configuration.service}/#{UserapiAi.configuration.api_version}/#{path}"
+      str += "?" + URI.encode_www_form(parameters) unless parameters.empty?
+      str
+    end
+
+    def headers
+      {
+        "Content-Type" => "application/json",
+        "api-key" => UserapiAi.configuration.access_token
+      }.merge(UserapiAi.configuration.extra_headers)
+    end
+
+    def multipart_parameters(parameters)
+      parameters&.transform_values do |value|
+        next value unless value.is_a?(File)
+
+        # Doesn't seem like Midjourney needs mime_type yet, so not worth
+        # the library to figure this out. Hence the empty string
+        # as the second argument.
+        Faraday::UploadIO.new(value, "", value.path)
+      end
+    end
+  end
+end

data/lib/userapi/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module UserapiAi
+  VERSION = "0.1.0"
+end
+

data/lib/userapi-ai.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+# 
+require "faraday"
+require "faraday/multipart"
+
+require_relative "userapi/http"
+require_relative "userapi/client"
+require_relative "userapi/version"
+
+module UserapiAi
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+
+  class Configuration
+    attr_writer :access_token
+    attr_accessor :api_version, :extra_headers, :request_timeout, :uri_base, :service
+
+    def initialize
+      @access_token = nil
+      @api_version = :v2
+      @uri_base = "https://api.userapi.ai"
+      @request_timeout = 120
+      @service = :midjourney
+    end
+
+    def access_token
+      return @access_token if @access_token
+
+      error_text = "Userapi-Ai access token missing! See https://dashboard.userapi.ai/api-keys"
+      raise ConfigurationError, error_text
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= UserapiAi::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/sig/userapi/ai.rbs

@@ -0,0 +1,6 @@
+module Userapi
+  module Ai
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: userapi-ai
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Smolev Denis
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+description:
+email:
+- smolev@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby/userapi-ai.rb
+- lib/userapi-ai.rb
+- lib/userapi/client.rb
+- lib/userapi/compatibility.rb
+- lib/userapi/http.rb
+- lib/userapi/version.rb
+- sig/userapi/ai.rbs
+homepage: https://userapi.ai.
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://userapi.ai.
+  source_code_uri: https://github.com/neonix20b/userapi-ai
+  changelog_uri: https://github.com/neonix20b/userapi-ai/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.4
+signing_key:
+specification_version: 4
+summary: Userapi.ai (midjourney) + Ruby.
+test_files: []