pika_sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f659b6d06293ce587938c8bf9c68173d5a76c0f361c505e5b1b6958720fe18b3
+  data.tar.gz: 2900dfb5af5863c96bca8c8d0d439f48f41d8974c2b6cadea3cc8209224da18f
+SHA512:
+  metadata.gz: 56aa314045257aea4f5c5eefa0d21bb01208d464108868a39ad68dd785596d83a81a5718b6f99dfc4eff50a8e7f2cf8cff7069f150d45757c317f6dc8b0fad5c
+  data.tar.gz: effe28274f13987d4a688e120867d63adbe304f9cfce7d3b0eab9e453e8ff13b70bdfe7a701cdb227642f8f8766054c6dfad6a114ec20e02b0f3c5a9ebe74b07

data/.github/workflows/gem-push.yml

@@ -0,0 +1,34 @@
+name: Ruby Gem
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby 2.6
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+      with:
+        ruby-version: 2.6.10
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dineshpy07@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pika_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 dineshs91
+
+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,103 @@
+# PikaApi
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pika_sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pika_sdk
+
+## Usage
+
+### Generate image
+
+Initialise a client
+
+```ruby
+require 'pika_sdk'
+
+client = PikaApi::Client.new('sk-he2jdus1cbz1dpt4mktgjyvx')
+```
+
+If you don't have your API key, get one from [Pika.style](https://pika.style).
+
+Check the documentation on [How to get your API key](https://docs.pika.style/docs/basics/getting-api-key).
+
+```ruby
+response = client.generate_image_from_template('open-graph-image-1', {'title': 'From python sdk new'}, 'base64')
+puts response['data']['base64']
+```
+
+**Example:**
+
+`Base64` response format.
+
+```ruby
+require 'pika_sdk'
+
+client = PikaApi::Client.new('sk-he2jdus1cbz1dpt4mktgjyvx')
+
+response = client.generate_image_from_template('open-graph-image-1', {'title': 'From ruby sdk'}, 'base64')
+puts response['data']['base64']
+```
+
+Base64 output
+
+```
+data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABLAAAAJ2CAYAAABPQHtcAAAAAXNSR0IArs4c6QAAIABJREFUeJzs3XmYJXdZL/Bvna37dM90FghLCBAQkC1BCBAMShLFBJAgKnofroBeFUUF5LrhiihXcV8BQRYVUUAlIewIGPbFmLCFLWwCYZEtzPR+trp/TM/......
+```
+
+`Binary` response format.
+
+```ruby
+require 'pika_sdk'
+
+client = PikaApi::Client.new('sk-he2jdus1cbz1dpt4mktgjyvx')
+
+File.open("og.png", "w") do |file|
+  response = client.generate_image_from_template('open-graph-image-1', {'title': 'From ruby sdk'}, 'binary')
+  file.binmode
+  file.write(response)
+end
+```
+
+This example writes the binary image to the file `og.png`.
+
+## generate_image_from_template
+
+Use this function to generate an image. It takes in 3 arguments
+
+| argument | required | description |
+|----------|----------|-------------|
+|`template_id` | Yes | ID of the template (`open-graph-image-1`, `tweet-image-1`, `beautify-screenshot-1`, ...) |
+|`modifications` | Yes | Modifications for the selected template. |
+|`response_format` | No | `base64` or `binary` (Defaults to `base64`). |
+
+For available templates and it's modifications refer [image generation api templates](https://pika.style/image-generation-api/templates).
+
+## 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 tags, 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/[USERNAME]/pika_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PikaApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/pika_api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pika_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pika_sdk/client.rb

@@ -0,0 +1,50 @@
+require "uri"
+require "json"
+require "net/http"
+require "httparty"
+
+module PikaApi
+  class Client
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def generate_image_from_template(template_id, modifications, response_format = 'base64')
+      endpoint_url = "#{get_base_url()}/templates/#{template_id}/images"
+
+      data = {
+        "response_format" => response_format,
+        "modifications" => modifications
+      }
+      
+      response = HTTParty.post("#{endpoint_url}", 
+    		body: data.to_json,
+    		headers: { 
+    			'Authorization' => "Bearer #{@api_key}",
+    			'Content-Type' => 'application/json'
+    		}
+    	)
+
+      
+      if response.code == 200
+        if response_format == "base_64"
+          response_body = JSON.parse(response.body)
+          return response_body
+        else
+          return response
+        end
+      else
+        response_body = JSON.parse(response.body)
+        raise Error.new(response_body["error"])
+      end
+    end
+
+    private 
+
+    def get_base_url(version = 'v1')
+      base_url = "https://api.pika.style"
+
+      "#{base_url}/#{version}"
+    end
+  end
+end

data/lib/pika_sdk/version.rb

@@ -0,0 +1,3 @@
+module PikaApi
+  VERSION = "0.1.0"
+end

data/lib/pika_sdk.rb

@@ -0,0 +1,6 @@
+require 'pika_sdk/version'
+require 'pika_sdk/client'
+
+module PikaApi
+  class Error < StandardError; end
+end

data/pika_sdk.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pika_sdk/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pika_sdk"
+  spec.version       = PikaApi::VERSION
+  spec.authors       = ["rishimohan"]
+  spec.email         = ["iamrishi.ms@gmail.com"]
+
+  spec.summary       = "Pika API sdk for ruby"
+  spec.description   = "Pika API sdk for ruby"
+  spec.homepage      = "https://github.com/rishimohan/pika-api-ruby-gem"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/rishimohan/pika-api-ruby-gem"
+    spec.metadata["changelog_uri"] = "https://github.com/rishimohan/pika-api-ruby-gem"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "httparty"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: pika_sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- rishimohan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Pika API sdk for ruby
+email:
+- iamrishi.ms@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pika_sdk.rb
+- lib/pika_sdk/client.rb
+- lib/pika_sdk/version.rb
+- pika_sdk.gemspec
+homepage: https://github.com/rishimohan/pika-api-ruby-gem
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/rishimohan/pika-api-ruby-gem
+  source_code_uri: https://github.com/rishimohan/pika-api-ruby-gem
+  changelog_uri: https://github.com/rishimohan/pika-api-ruby-gem
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Pika API sdk for ruby
+test_files: []