zirp 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/LICENSE +21 -0
- data/README.md +138 -0
- metadata +142 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 6b9224678e74c088c6e88996ebd5411f8f2242880776548ca774351b43bb8b13
|
4
|
+
data.tar.gz: edf741b1ca0587fad0aea8e8be23e05bd0ad1b4a8f3ea8a1202544fbffa7a8c8
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: e2c9780e1b09b2de688e576257bcbc96297c7a62b76c69caea03aa887b9c9923bcdb64f85bf049024706faf8d9411bfb671d796850a0f16f94272b8680073540
|
7
|
+
data.tar.gz: d2dac6cc627a2c091e534563b5b6f013ec358c71e1a0a04387ecd962e5edba84e7fc3f848c3d2bd8dc87fe38a7b3a4073d85dfcae3e857af9a26022fb9b938f3
|
data/LICENSE
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
MIT License
|
2
|
+
|
3
|
+
Copyright (c) 2025 Zirp AI
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
21
|
+
SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,138 @@
|
|
1
|
+
<p align="center">
|
2
|
+
<img src="assets/zirp-logo.png" alt="Zirp Logo" width="150" height="150">
|
3
|
+
</p>
|
4
|
+
|
5
|
+
# Zirp
|
6
|
+
|
7
|
+
Zirp is a powerful Ruby client gem for interacting with the Zirp multi-platform content distribution system. It provides a simple and intuitive interface for managing content and publishing it to various platforms like Slack, Email, Twitter, LinkedIn, and more.
|
8
|
+
|
9
|
+
> **⚠️ BETA STATUS**: This project is currently in beta and not yet ready for production use. APIs and functionality may change without notice.
|
10
|
+
|
11
|
+
## Installation
|
12
|
+
|
13
|
+
Install the gem and add to the application's Gemfile by executing:
|
14
|
+
|
15
|
+
$ bundle add zirp
|
16
|
+
|
17
|
+
If bundler is not being used to manage dependencies, install the gem by executing:
|
18
|
+
|
19
|
+
$ gem install zirp
|
20
|
+
|
21
|
+
## Features
|
22
|
+
|
23
|
+
- **Content Management**: Create, update, and delete content across multiple platforms
|
24
|
+
- **AI-Powered Generation**: Generate content using LLM integration
|
25
|
+
- **Multi-Platform Publishing**: Publish content to Slack, Email, Twitter, LinkedIn, Notion, and more
|
26
|
+
- **Preview Mode**: Preview how content will appear on different platforms before publishing
|
27
|
+
- **Platform Management**: Add, configure, and validate platform credentials
|
28
|
+
- **CLI Interface**: Command-line tools for content and platform management
|
29
|
+
- **API Authentication**: Secure API key authentication
|
30
|
+
|
31
|
+
## Usage
|
32
|
+
|
33
|
+
### Configuration
|
34
|
+
|
35
|
+
```ruby
|
36
|
+
require 'zirp'
|
37
|
+
|
38
|
+
Zirp.configure do |config|
|
39
|
+
config.api_key = 'your_api_key'
|
40
|
+
config.endpoint = 'https://api.zirp.example.com'
|
41
|
+
config.timeout = 30 # seconds
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
### Client Usage
|
46
|
+
|
47
|
+
```ruby
|
48
|
+
# Initialize client
|
49
|
+
client = Zirp::Client.new
|
50
|
+
|
51
|
+
# List contents
|
52
|
+
contents = client.contents.list
|
53
|
+
|
54
|
+
# Create content
|
55
|
+
content = client.contents.create(
|
56
|
+
title: "Announcing Our New Feature",
|
57
|
+
body: "We're excited to announce...",
|
58
|
+
metadata: { tags: ["announcement", "feature"] }
|
59
|
+
)
|
60
|
+
|
61
|
+
# Generate content with AI
|
62
|
+
content = client.contents.generate(
|
63
|
+
id: content.id,
|
64
|
+
prompt_template: "Write an announcement for {{product_name}}",
|
65
|
+
context: { product_name: "Zirp" }
|
66
|
+
)
|
67
|
+
|
68
|
+
# Preview content on platforms
|
69
|
+
previews = client.contents.preview(id: content.id)
|
70
|
+
|
71
|
+
# Publish content to platforms
|
72
|
+
result = client.contents.publish(
|
73
|
+
id: content.id,
|
74
|
+
platform_ids: [1, 2, 3]
|
75
|
+
)
|
76
|
+
|
77
|
+
# List platforms
|
78
|
+
platforms = client.platforms.list
|
79
|
+
|
80
|
+
# Validate platform credentials
|
81
|
+
valid = client.platforms.validate_credentials(id: 1)
|
82
|
+
```
|
83
|
+
|
84
|
+
### CLI Usage
|
85
|
+
|
86
|
+
```bash
|
87
|
+
# Configure API key
|
88
|
+
$ zirp configure --api-key=your_api_key
|
89
|
+
|
90
|
+
# List contents
|
91
|
+
$ zirp contents list
|
92
|
+
|
93
|
+
# Create content
|
94
|
+
$ zirp contents create --title="Announcement" --body="Hello world"
|
95
|
+
|
96
|
+
# Generate content with AI
|
97
|
+
$ zirp contents generate --id=1 --prompt="Write an announcement"
|
98
|
+
|
99
|
+
# Preview content
|
100
|
+
$ zirp contents preview --id=1
|
101
|
+
|
102
|
+
# Publish content
|
103
|
+
$ zirp contents publish --id=1 --platforms=1,2,3
|
104
|
+
|
105
|
+
# List platforms
|
106
|
+
$ zirp platforms list
|
107
|
+
|
108
|
+
# Validate platform credentials
|
109
|
+
$ zirp platforms validate --id=1
|
110
|
+
```
|
111
|
+
|
112
|
+
## Development
|
113
|
+
|
114
|
+
### Setup
|
115
|
+
|
116
|
+
```bash
|
117
|
+
# Clone the repository
|
118
|
+
git clone https://github.com/your-username/zirp_rb.git
|
119
|
+
cd zirp_rb
|
120
|
+
|
121
|
+
# Install dependencies
|
122
|
+
bundle install
|
123
|
+
|
124
|
+
# Run tests
|
125
|
+
rake spec
|
126
|
+
```
|
127
|
+
|
128
|
+
### Contributing
|
129
|
+
|
130
|
+
1. Fork the repository
|
131
|
+
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
|
132
|
+
3. Commit your changes (`git commit -am 'Add some amazing feature'`)
|
133
|
+
4. Push to the branch (`git push origin feature/amazing-feature`)
|
134
|
+
5. Create a new Pull Request
|
135
|
+
|
136
|
+
## License
|
137
|
+
|
138
|
+
MIT
|
metadata
ADDED
@@ -0,0 +1,142 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: zirp
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Chris Davis
|
8
|
+
bindir: exe
|
9
|
+
cert_chain: []
|
10
|
+
date: 2025-08-20 00:00:00.000000000 Z
|
11
|
+
dependencies:
|
12
|
+
- !ruby/object:Gem::Dependency
|
13
|
+
name: slack-ruby-block-kit
|
14
|
+
requirement: !ruby/object:Gem::Requirement
|
15
|
+
requirements:
|
16
|
+
- - "~>"
|
17
|
+
- !ruby/object:Gem::Version
|
18
|
+
version: 0.20.0
|
19
|
+
type: :runtime
|
20
|
+
prerelease: false
|
21
|
+
version_requirements: !ruby/object:Gem::Requirement
|
22
|
+
requirements:
|
23
|
+
- - "~>"
|
24
|
+
- !ruby/object:Gem::Version
|
25
|
+
version: 0.20.0
|
26
|
+
- !ruby/object:Gem::Dependency
|
27
|
+
name: slack-ruby-client
|
28
|
+
requirement: !ruby/object:Gem::Requirement
|
29
|
+
requirements:
|
30
|
+
- - "~>"
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: 2.1.0
|
33
|
+
type: :runtime
|
34
|
+
prerelease: false
|
35
|
+
version_requirements: !ruby/object:Gem::Requirement
|
36
|
+
requirements:
|
37
|
+
- - "~>"
|
38
|
+
- !ruby/object:Gem::Version
|
39
|
+
version: 2.1.0
|
40
|
+
- !ruby/object:Gem::Dependency
|
41
|
+
name: nokogiri
|
42
|
+
requirement: !ruby/object:Gem::Requirement
|
43
|
+
requirements:
|
44
|
+
- - "~>"
|
45
|
+
- !ruby/object:Gem::Version
|
46
|
+
version: 1.15.0
|
47
|
+
type: :runtime
|
48
|
+
prerelease: false
|
49
|
+
version_requirements: !ruby/object:Gem::Requirement
|
50
|
+
requirements:
|
51
|
+
- - "~>"
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: 1.15.0
|
54
|
+
- !ruby/object:Gem::Dependency
|
55
|
+
name: mail
|
56
|
+
requirement: !ruby/object:Gem::Requirement
|
57
|
+
requirements:
|
58
|
+
- - "~>"
|
59
|
+
- !ruby/object:Gem::Version
|
60
|
+
version: 2.8.1
|
61
|
+
type: :runtime
|
62
|
+
prerelease: false
|
63
|
+
version_requirements: !ruby/object:Gem::Requirement
|
64
|
+
requirements:
|
65
|
+
- - "~>"
|
66
|
+
- !ruby/object:Gem::Version
|
67
|
+
version: 2.8.1
|
68
|
+
- !ruby/object:Gem::Dependency
|
69
|
+
name: rake
|
70
|
+
requirement: !ruby/object:Gem::Requirement
|
71
|
+
requirements:
|
72
|
+
- - "~>"
|
73
|
+
- !ruby/object:Gem::Version
|
74
|
+
version: '13.0'
|
75
|
+
type: :development
|
76
|
+
prerelease: false
|
77
|
+
version_requirements: !ruby/object:Gem::Requirement
|
78
|
+
requirements:
|
79
|
+
- - "~>"
|
80
|
+
- !ruby/object:Gem::Version
|
81
|
+
version: '13.0'
|
82
|
+
- !ruby/object:Gem::Dependency
|
83
|
+
name: rspec
|
84
|
+
requirement: !ruby/object:Gem::Requirement
|
85
|
+
requirements:
|
86
|
+
- - "~>"
|
87
|
+
- !ruby/object:Gem::Version
|
88
|
+
version: '3.0'
|
89
|
+
type: :development
|
90
|
+
prerelease: false
|
91
|
+
version_requirements: !ruby/object:Gem::Requirement
|
92
|
+
requirements:
|
93
|
+
- - "~>"
|
94
|
+
- !ruby/object:Gem::Version
|
95
|
+
version: '3.0'
|
96
|
+
- !ruby/object:Gem::Dependency
|
97
|
+
name: rubocop
|
98
|
+
requirement: !ruby/object:Gem::Requirement
|
99
|
+
requirements:
|
100
|
+
- - "~>"
|
101
|
+
- !ruby/object:Gem::Version
|
102
|
+
version: '1.21'
|
103
|
+
type: :development
|
104
|
+
prerelease: false
|
105
|
+
version_requirements: !ruby/object:Gem::Requirement
|
106
|
+
requirements:
|
107
|
+
- - "~>"
|
108
|
+
- !ruby/object:Gem::Version
|
109
|
+
version: '1.21'
|
110
|
+
description: Zirp is a comprehensive tool for creating and distributing product release
|
111
|
+
notes with video demos and multi-channel notifications (Slack, Email, Twitter, LinkedIn)
|
112
|
+
email:
|
113
|
+
- chrisdavis179@gmail.com
|
114
|
+
executables: []
|
115
|
+
extensions: []
|
116
|
+
extra_rdoc_files: []
|
117
|
+
files:
|
118
|
+
- LICENSE
|
119
|
+
- README.md
|
120
|
+
homepage: https://github.com/zirp-ai/zirp_rb
|
121
|
+
licenses:
|
122
|
+
- MIT
|
123
|
+
metadata:
|
124
|
+
homepage_uri: https://github.com/zirp-ai/zirp_rb
|
125
|
+
rdoc_options: []
|
126
|
+
require_paths:
|
127
|
+
- lib
|
128
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
129
|
+
requirements:
|
130
|
+
- - ">="
|
131
|
+
- !ruby/object:Gem::Version
|
132
|
+
version: 2.6.0
|
133
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
134
|
+
requirements:
|
135
|
+
- - ">="
|
136
|
+
- !ruby/object:Gem::Version
|
137
|
+
version: '0'
|
138
|
+
requirements: []
|
139
|
+
rubygems_version: 3.6.2
|
140
|
+
specification_version: 4
|
141
|
+
summary: Zirp - A powerful release notes and notification tool
|
142
|
+
test_files: []
|