pika_sdk 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f659b6d06293ce587938c8bf9c68173d5a76c0f361c505e5b1b6958720fe18b3
-  data.tar.gz: 2900dfb5af5863c96bca8c8d0d439f48f41d8974c2b6cadea3cc8209224da18f
+  metadata.gz: 761d54b607516e99b86b18976893c99aa08c0443a24406202f7fe1e24f17bf6e
+  data.tar.gz: 8b3ca1c82b99e4d6519cdadc267c2dad3ed515124f91a249d9daf4c21cd43889
 SHA512:
-  metadata.gz: 56aa314045257aea4f5c5eefa0d21bb01208d464108868a39ad68dd785596d83a81a5718b6f99dfc4eff50a8e7f2cf8cff7069f150d45757c317f6dc8b0fad5c
-  data.tar.gz: effe28274f13987d4a688e120867d63adbe304f9cfce7d3b0eab9e453e8ff13b70bdfe7a701cdb227642f8f8766054c6dfad6a114ec20e02b0f3c5a9ebe74b07
+  metadata.gz: 1bff87e3d33fdcdbca018763d374b8504d182c7686391692e8c991e684df408d14e4d3348951c25c8e33fe73dffdb2588a67d9837c588222a2c7a3c599345b20
+  data.tar.gz: b95bbd4eaa4e58ed74d27fc40bf35a3f4dadb550f22ac2f1f36162a2755d05529e9f9439d79c34bf75f9e5d8a09f4bd925670f23da8da26da8513411690e2621

data/README.md

@@ -1,4 +1,6 @@
-# PikaApi
+# Pika API Ruby Gem
+
+View on Rubygems: [rubygems.org/gems/pika_sdk](https://rubygems.org/gems/pika_sdk)
 
 ## Installation
 
@@ -18,33 +20,31 @@ Or install it yourself as:
 
 ## Usage
 
-### Generate image
+If you don't have your API key, get one from [pika.style](https://pika.style/pricing). Check the documentation on [how to get your API key](https://docs.pika.style/docs/basics/getting-api-key)
 
-Initialise a client
+### Initialise a client
 
 ```ruby
 require 'pika_sdk'
 
-client = PikaApi::Client.new('sk-he2jdus1cbz1dpt4mktgjyvx')
+client = PikaSdk::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).
+### Generate image
 
 ```ruby
 response = client.generate_image_from_template('open-graph-image-1', {'title': 'From python sdk new'}, 'base64')
 puts response['data']['base64']
 ```
 
-**Example:**
+## Example
 
-`Base64` response format.
+### `Base64` response format
 
 ```ruby
 require 'pika_sdk'
 
-client = PikaApi::Client.new('sk-he2jdus1cbz1dpt4mktgjyvx')
+client = PikaSdk::Client.new('sk-he2jdus1cbz1dpt4mktgjyvx')
 
 response = client.generate_image_from_template('open-graph-image-1', {'title': 'From ruby sdk'}, 'base64')
 puts response['data']['base64']
@@ -56,12 +56,12 @@ Base64 output
 data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABLAAAAJ2CAYAAABPQHtcAAAAAXNSR0IArs4c6QAAIABJREFUeJzs3XmYJXdZL/Bvna37dM90FghLCBAQkC1BCBAMShLFBJAgKnofroBeFUUF5LrhiihXcV8BQRYVUUAlIewIGPbFmLCFLWwCYZEtzPR+trp/TM/......
 ```
 
-`Binary` response format.
+### `Binary` response format
 
 ```ruby
 require 'pika_sdk'
 
-client = PikaApi::Client.new('sk-he2jdus1cbz1dpt4mktgjyvx')
+client = PikaSdk::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')
@@ -70,7 +70,7 @@ File.open("og.png", "w") do |file|
 end
 ```
 
-This example writes the binary image to the file `og.png`.
+This example writes the binary image to the file `og.png`
 
 ## generate_image_from_template
 
@@ -82,7 +82,7 @@ Use this function to generate an image. It takes in 3 arguments
 |`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).
+For available templates and their modifications refer [image generation api templates](https://pika.style/image-generation-api/templates)
 
 ## Development
 
@@ -92,7 +92,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rishimohan/pika-api-ruby-gem. 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
 
@@ -100,4 +100,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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).
+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/rishimohan/pika-api-ruby-gem/blob/master/CODE_OF_CONDUCT.md).

data/lib/pika_sdk/client.rb

@@ -3,7 +3,7 @@ require "json"
 require "net/http"
 require "httparty"
 
-module PikaApi
+module PikaSdk
   class Client
     def initialize(api_key)
       @api_key = api_key

data/lib/pika_sdk/version.rb

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

data/lib/pika_sdk.rb

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

data/pika_sdk.gemspec

@@ -5,13 +5,13 @@ require "pika_sdk/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "pika_sdk"
-  spec.version       = PikaApi::VERSION
+  spec.version       = PikaSdk::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.homepage      = "https://pika.style/image-generation-api"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pika_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - rishimohan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-11 00:00:00.000000000 Z
+date: 2024-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,12 +72,12 @@ files:
 - lib/pika_sdk/client.rb
 - lib/pika_sdk/version.rb
 - pika_sdk.gemspec
-homepage: https://github.com/rishimohan/pika-api-ruby-gem
+homepage: https://pika.style/image-generation-api
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org/
-  homepage_uri: https://github.com/rishimohan/pika-api-ruby-gem
+  homepage_uri: https://pika.style/image-generation-api
   source_code_uri: https://github.com/rishimohan/pika-api-ruby-gem
   changelog_uri: https://github.com/rishimohan/pika-api-ruby-gem
 post_install_message: