Initial commit

README.md

@@ -1 +1,42 @@
-# podcast-api-ruby
+# Podcast API Ruby Library
+
+[![Build Status](https://travis-ci.com/ListenNotes/podcast-api-ruby.svg?branch=main)](https://travis-ci.com/ListenNotes/podcast-api-ruby)
+
+The Podcast API Ruby library provides convenient access to the [Listen Notes Podcast API](https://www.listennotes.com/api/) from
+applications written in Ruby.
+
+Simple and no-nonsense podcast search & directory API. Search the meta data of all podcasts and episodes by people, places, or topics.
+
+<a href="https://www.listennotes.com/api/"><img src="https://raw.githubusercontent.com/ListenNotes/ListenApiDemo/master/web/src/powered_by_listennotes.png" width="300" /></a>
+
+## Documentation
+
+See the [Listen Notes Podcast API docs](https://www.listennotes.com/api/docs/).
+
+
+## Installation
+
+Install the package with:
+```sh
+gem install podcast-api
+```
+
+
+### Requirements
+
+- Ruby 2.3+
+
+## Usage
+
+The library needs to be configured with your account's API key which is
+available in your [Listen API Dashboard](https://www.listennotes.com/api/dashboard/#apps). Set `apiKey` to its
+value:
+
+```ruby
+
+# TODO
+```
+
+If `apiKey` is null, then we'll connect to a [mock server](https://www.listennotes.com/api/tutorials/#faq0) that returns fake data for testing purposes.
+
+You can see all available API endpoints and parameters on the API Docs page at [listennotes.com/api/docs/](https://www.listennotes.com/api/docs/).

examples/Gemfile

@@ -0,0 +1 @@
+gem "podcast_api", path: "../"

examples/Gemfile.lock

@@ -0,0 +1,16 @@
+PATH
+  remote: ..
+  specs:
+    podcast_api (1.0.1)
+
+GEM
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  podcast_api!
+
+BUNDLED WITH
+   1.17.2

examples/sample.rb

@@ -0,0 +1 @@
+require "podcast_api"

lib/podcast_api.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "net/http"
+
+# Version
+require "version"
+
+puts PodcastApi::VERSION
+
+module PodcastApi
+end

lib/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PodcastApi
+  VERSION = "1.0.1"
+end

podcast_api.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(::File.join(::File.dirname(__FILE__), "lib"))
+
+require "version"
+
+Gem::Specification.new do |s|
+  s.name = "podcast_api"
+  s.version = PodcastApi::VERSION
+  s.required_ruby_version = ">= 2.3.0"
+  s.summary = "Ruby bindings for the Listen Notes Podcast API"
+  s.description = "Listen Notes is the best podcast search engine and api.  " \
+                  "See https://www.listennotes.com/api/ for details."
+  s.author = "Listen Notes, Inc."
+  s.email = "[email protected]"
+  s.homepage = "https://www.listennotes.com/api/"
+  s.license = "MIT"
+
+  s.metadata = {
+    "bug_tracker_uri" => "https://github.com/ListenNotes/podcast-api-ruby/issues",
+    "changelog_uri" =>
+      "https://github.com/ListenNotes/podcast-api-ruby/releases",
+    "documentation_uri" => "https://www.listennotes.com/api/docs/",
+    "github_repo" => "https://github.com/ListenNotes/podcast-api-ruby",
+    "homepage_uri" => "https://www.listennotes.com/api/",
+    "source_code_uri" => "https://github.com/ListenNotes/podcast-api-ruby",
+  }
+
+  ignored = Regexp.union(
+    /\A\.editorconfig/,
+    /\A\.git/,
+    /\A\.rubocop/,
+    /\A\.travis.yml/,
+    /\Atest/
+  )
+  s.files = `git ls-files`.split("\n").reject { |f| ignored.match(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n")
+                                           .map { |f| ::File.basename(f) }
+  s.require_paths = ["lib"]
+end