clnk_api 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7a11f7eafeb4fc8c2b5acb145e7b88fd1a7bb2d0
-  data.tar.gz: defe5b022aaca6257cf204e649be4cd5a751572f
+SHA256:
+  metadata.gz: aadd78f740df8828fa1f9c8c9b07eca199178d6a0b737932ad004a027df836bb
+  data.tar.gz: 2ef777e85b8783dd1a3fc3f7e0cb3432a8205f9014a55238308d10b1103bcc31
 SHA512:
-  metadata.gz: 4af510700054aefed5b211c6a4829d516f020cb3d2940af54318a60a2eba6f4d1dead76117d0686ddfa628a600834e64cda66836cb1fb2c375074a392a168e07
-  data.tar.gz: 76bf454cdf98d48d99ffdfb081bcf53b58decd2967e47d5e1b8df876f45d047f15095a9c71f80d5e7c3e6bcff554192c7cfde3b1d3072fea1438c41c68d465c6
+  metadata.gz: 54b80490dff6e20b0e70f1586acd9e133f20c18f4740a93412dfc979801d1655700bf73538b2337c5bf9ee71bd5b6f8cccd81ec3171aa2f5e99a8a933994a7b1
+  data.tar.gz: cbac5854628067c65699f6387218b5a10edd9255f01429e64634c05189598406e0d914af66e1dcbde79d230cec4aa10b67d988cb0bec1762aad03f59693f92dc

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.0.5] - 2024-10-08
+
+### Changed
+- Relaxed HTTParty dependency from `~> 0.17.3` to `>= 0.13.0` for better compatibility
+- Relaxed multi_json dependency from `~> 1.11.2` to `>= 1.10` for better compatibility
+- This allows the gem to work with newer versions of HTTParty (tested up to 0.23.x) and multi_json (tested up to 1.15.x)
+- Resolves Bundler dependency conflicts with other gems that require different versions of these libraries
+
+## [0.0.4] - 2024-10-08
+
+### Added
+- Support for custom base URI configuration
+- Users can now specify alternative API endpoints when initializing the client
+- Example: `ClnkApi::Clnk.new("token", "https://custom.api.example.com")`
+
+### Changed
+- Updated Clnk initializer to accept optional base_uri parameter
+- Updated Link class to use configurable base URI
+
+## [0.0.3] - 2014-11-14
+
+### Changed
+- Updated to use HTTPS instead of HTTP for API endpoints
+
+## [0.0.2] - 2014-11-11
+
+### Changed
+- Updated HTTParty gem version
+
+## [0.0.1] - 2014-11-11
+
+### Added
+- Initial release
+- URL shortening functionality
+- URL expansion functionality
+- URL info retrieval
+- Bulk URL operations
+- Error handling for API responses

data/CLAUDE.md

@@ -0,0 +1,112 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+ClnkApi is a Ruby gem that provides a client library for interacting with the Clnk URL shortening service API. It supports URL shortening, expansion, info retrieval, and bulk operations.
+
+## Development Commands
+
+### Essential Commands
+```bash
+# Install dependencies
+bundle install
+
+# Build the gem
+gem build clnk_api.gemspec
+
+# Install the gem locally
+gem install ./clnk_api-0.0.3.gem
+
+# Run console with gem loaded
+irb -r ./lib/clnk_api
+
+# Release new version
+rake release
+```
+
+## Architecture Overview
+
+### Core Components
+
+- **`lib/clnk_api/clnk.rb`**: Main client class that handles API authentication and provides high-level methods
+- **`lib/clnk_api/link.rb`**: Low-level API operations and HTTP request handling
+- **`lib/clnk_api/errors.rb`**: Custom error classes mapped to HTTP status codes
+
+### API Operations
+
+The gem supports four main operations:
+
+1. **Shorten**: Convert long URLs to short Clnk URLs
+2. **Expand**: Retrieve original URL from short code
+3. **Info**: Get detailed information about a shortened URL
+4. **Bulk**: Process multiple URLs in a single request
+
+### Key Implementation Details
+
+#### URL Validation
+- Accepts String, Array, or Hash inputs
+- Validates URLs against URI.regexp for HTTP/HTTPS protocols
+- Automatically adds "http://" prefix if protocol is missing
+
+#### Error Handling
+Maps HTTP status codes to specific error classes:
+- 401 → `Unauthorized` (invalid API key)
+- 400 → `General` (validation errors)
+- 404 → `NotFound` (invalid short code)
+- 500 → `InformClnk` (server error)
+- 503 → `Unavailable` (service down)
+
+#### API Configuration
+- Base URI: `https://api.clnk.in`
+- Authentication via access token in request headers
+- Uses HTTParty for HTTP client functionality
+- JSON parsing with multi_json gem
+
+## Testing Approach
+
+Currently no test suite is implemented. When adding tests:
+```bash
+# Recommended test framework setup
+bundle add rspec --group test
+bundle exec rspec --init
+
+# Run tests (once implemented)
+bundle exec rspec
+```
+
+## Usage Examples
+
+```ruby
+# Initialize client
+clnk = ClnkApi::Clnk.new("your_access_token")
+
+# Shorten URL
+short_url = clnk.shorten("https://example.com/very/long/url")
+
+# Expand short code
+original_url = clnk.expand("abc123")
+
+# Get URL info
+info = clnk.info("https://clnk.in/abc123")
+
+# Bulk operations
+urls = ["https://example1.com", "https://example2.com"]
+results = clnk.bulk(urls)
+```
+
+## External Dependencies
+
+- **HTTParty (~> 0.17.3)**: HTTP client library
+- **multi_json (~> 1.11.2)**: JSON parsing
+- **bundler (~> 1.7)**: Dependency management
+- **rake (~> 10.0)**: Task automation
+
+## Version Management
+
+Current version is defined in `lib/clnk_api/version.rb`. To release a new version:
+1. Update version number in `lib/clnk_api/version.rb`
+2. Update CHANGELOG if present
+3. Commit changes
+4. Run `rake release` to build, tag, and push to RubyGems

data/README.md

@@ -20,11 +20,24 @@ Or install it yourself as:
 
 ## Usage
 
+### Basic Usage
+
     clnk = ClnkApi::Clnk.new("AccessToken")
     # Clnk::Link contains :short_url,:long_url,short_code
     link = clnk.shorten(url) # return ClnkApi::Link
     link = clnk.expand("shortcode") # return ClnkApi::Link
     link = clnk.info("shorturl") # return ClnkApi::Link
+    link = clnk.bulk(urls) # where urls can be Array or Hash
+
+### Using Custom Base URI (v0.0.4+)
+
+You can now specify a custom base URI when initializing the client:
+
+    # Use custom base URI
+    clnk = ClnkApi::Clnk.new("AccessToken", "https://custom.api.example.com")
+    
+    # The default base URI (https://api.clnk.in) is used if not specified
+    clnk = ClnkApi::Clnk.new("AccessToken")
     
 
 ## Contributing

data/clnk_api.gemspec

@@ -6,11 +6,11 @@ require 'clnk_api/version'
 Gem::Specification.new do |spec|
   spec.name          = "clnk_api"
   spec.version       = ClnkApi::VERSION
-  spec.authors       = ["amardaxini"]
-  spec.email         = ["amardaxini@gmail.com"]
-  spec.summary       = %q{Clnk Client API}
-  spec.description   = %q{Clnk Client API}
-  spec.homepage      = ""
+  spec.authors       = ["mothirajha"]
+  spec.email         = ["rajha12@gmail.com"]
+  spec.summary       = %q{Ruby client for Cuelinks URL shortening API}
+  spec.description   = %q{A Ruby gem that provides a client library for interacting with the Cuelinks URL shortening service. Supports URL shortening, expansion, info retrieval, bulk operations, and custom base URIs.}
+  spec.homepage      = "https://github.com/cuelinks/clnk_api"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -20,6 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "httparty"
-  spec.add_development_dependency "multi_json"
+  spec.add_dependency "httparty", ">= 0.13.0", "< 1.0"
+  spec.add_dependency "multi_json", ">= 1.10", "< 2.0"
 end

data/lib/clnk_api/clnk.rb

@@ -1,26 +1,35 @@
 module ClnkApi
   class Clnk
 
-    attr_accessor :api_key
-    def initialize(api_key)
+    attr_accessor :api_key, :base_uri
+    def initialize(api_key, base_uri = nil)
       @api_key = api_key
+      @base_uri = base_uri || 'https://api.clnk.in'
     end
 
     def shorten(url)
-      link = ClnkApi::Link.new(@api_key)
+      link = ClnkApi::Link.new(@api_key, @base_uri)
       link.shorten(url)
       link
     end
 
     def info(url)
-      link = ClnkApi::Link.new(@api_key)
+      link = ClnkApi::Link.new(@api_key, @base_uri)
       link.info(url)
       link
     end
+
     def expand(url)
-      link = ClnkApi::Link.new(@api_key)
+      link = ClnkApi::Link.new(@api_key, @base_uri)
       link.expand(url)
       link
     end
+
+    def bulk(urls)
+      link = ClnkApi::Link.new(@api_key, @base_uri)
+      link.bulk_shorten(urls)
+      link
+    end
+
   end
-end
+end

data/lib/clnk_api/link.rb

@@ -1,14 +1,27 @@
 module ClnkApi
   class Link 
     include HTTParty
-    base_uri 'http://api.clnk.in'
-    attr_accessor :long_url, :short_url, :short_code,:api_key,:clicks
-    def initialize(api_key)
+    attr_accessor :long_url, :short_url, :short_code,:api_key,:clicks, :bulk_urls
+    def initialize(api_key, base_uri = nil)
       @api_key = api_key
+      @base_uri = base_uri || 'https://api.clnk.in'
+      self.class.base_uri @base_uri
     end
 
-    def validate_url(url)
-      raise ClnkApi::General.new("Url is invalid.") unless  url =~ /\A#{URI::regexp(['http', 'https'])}\z/
+    def validate_url(urls)
+      case urls.class.to_s
+      when "String"
+        raise ClnkApi::General.new("Url is invalid.") unless  urls =~ /\A#{URI::regexp(['http', 'https'])}\z/
+      when "Array"
+        urls.each do |url|
+          raise ClnkApi::General.new("Url is invalid.") unless  url =~ /\A#{URI::regexp(['http', 'https'])}\z/
+        end
+      when "Hash"
+        urls.each do |k, url|
+          raise ClnkApi::General.new("Url is invalid.") unless  url =~ /\A#{URI::regexp(['http', 'https'])}\z/
+        end
+      end
+      
     end
 
     def info(url)
@@ -26,25 +39,31 @@ module ClnkApi
       handle_response(response)
     end
 
-    
-
     def shorten(url)
       validate_url(url)
       long_url = url
       options = {:body=>{ :long_url=> long_url,:access_token=> @api_key} }
       response = self.class.post("/api/v1/links/shorten", options)
       handle_response(response)
-
-      
-      
     end
 
+    def bulk_shorten(urls)
+      validate_url(urls)
+      options = {:body=>{:urls=> urls.to_json,:access_token=>@api_key} }
+      response = self.class.post("/api/v1/links/bulk_shorten", options)
+      handle_bulk_response(response)
+    end
 
     def handle_response(response)
       raise_errors(response)
       build_response(response)
     end
 
+    def handle_bulk_response(response)
+      raise_errors(response)
+      bulk_response(response)
+    end
+
     def raise_errors(response)
       code = response.code.to_i
       case code
@@ -68,10 +87,13 @@ module ClnkApi
         self.short_url ||= url_data["short_url"]
         self.short_code ||= url_data["short_code"]
         self.clicks ||= url_data["clicks"]
-
       end
     end
 
+    def bulk_response(response)
+      self.bulk_urls = response.body
+    end
+
   end
 end
 

data/lib/clnk_api/version.rb

@@ -1,3 +1,3 @@
 module ClnkApi
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clnk_api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
-- amardaxini
-autorequire: 
+- mothirajha
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-11-14 00:00:00.000000000 Z
+date: 2025-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,51 +44,68 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 0.13.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: Clnk Client API
+        version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A Ruby gem that provides a client library for interacting with the Cuelinks
+  URL shortening service. Supports URL shortening, expansion, info retrieval, bulk
+  operations, and custom base URIs.
 email:
-- amardaxini@gmail.com
+- rajha12@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
+- CLAUDE.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- clnk_api-0.0.4.gem
 - clnk_api.gemspec
 - lib/clnk_api.rb
 - lib/clnk_api/clnk.rb
 - lib/clnk_api/errors.rb
 - lib/clnk_api/link.rb
 - lib/clnk_api/version.rb
-homepage: ''
+homepage: https://github.com/cuelinks/clnk_api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,9 +120,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
-summary: Clnk Client API
+summary: Ruby client for Cuelinks URL shortening API
 test_files: []