simplecast 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9536b3ee8b553a3ce185476b5ff227d31c88c68
+  data.tar.gz: 1a2e159074874634a80e6dcf4c4963fc8ca94286
+SHA512:
+  metadata.gz: ffe95bc4cfd4254e895f5042008600dcddeb9df0579a4ac373a9359abe6e85d093fd6768fb91aaa64d90246a1b2b460e829a64093a8e00b9d15a41f98b24ce14
+  data.tar.gz: 6b25a7045ec9a12daaa787f054fc0761a5e1af3d304f63016c73aad5a906daf55b9951ecff030f4c6ab7d7cb0cf825cf9d9eaa630eb879166753547c70a95a87

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    simplecast (0.0.1)
+      hurley (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    hurley (0.1)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  rake (~> 10.0)
+  rspec
+  simplecast!

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jonathan Cutrell
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jonathan Cutrell
+
+MIT License
+
+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,66 @@
+# Simplecast
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simplecast'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simplecast
+
+## Usage
+
+Set up the gem in a config file (if you're using Rails, just add something like a simplecast.rb in initializers).
+
+Right now, there are only two config options: `api_key` and `podcast_id`. Your API key can be found in your [account settings](https://simplecast.fm/user/edit).
+
+Your `podcast_id` is in the URL for your account, and is likely just a number.
+
+```ruby
+Simplecast.configure do |c|
+  c.api_key "Your_api_key_here"
+  c.podcast_id "Your_podcast_id_here"
+end
+```
+
+Next, you can access Podcasts, Episodes, and Statistics like this:
+
+```ruby
+# Episodes
+Simplecast::Client::Episode.all # gets all podcasts, as long as podcast_id was set in the config
+Simplecast::Client::Episode.all(podcast_id) # gets all podcasts, as long as podcast_id was set in the config
+Simplecast::Client::Episode.find(episode_id)
+Simplecast::Client::Episode.find(episode_id, podcast_id)
+
+# Podcast
+Simplecast::Client::Podcast.all
+Simplecast::Client::Podcast.find(podcast_id)
+
+# Statistics
+# the overall method takes timeframe parameters as defined at https://api.simplecast.fm - /podcasts/:podcast_id/statistics/overall.json 
+Simplecast::Client::Statistic.overall(podcast_id, options:{})
+
+# returns listener stats. /podcasts/:podcast_id/statistics.json
+Simplecast::Client::Statistic.all(podcast_id)
+
+# returns stats for a given episode. Takes timeframe params. /podcasts/:podcast_id/statistics/episode.json
+Simplecast::Client::Statistic.for_episode(episode_id, podcast_id: nil, opts: {})
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/simplecast/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/simplecast.rb

@@ -0,0 +1,24 @@
+$:.unshift File.dirname(__FILE__)
+require "simplecast/version"
+require "simplecast/configurable"
+
+require "simplecast/model"
+require "simplecast/podcast"
+require "simplecast/episode"
+require "simplecast/statistic"
+
+require "simplecast/client"
+require "simplecast/client/resource"
+require "simplecast/client/podcast"
+require "simplecast/client/episode"
+require "simplecast/client/statistic"
+
+module Simplecast
+  class << self
+    include Simplecast::Configurable
+    def client
+      @client = Simplecast::Client.new(options) unless defined?(@client)
+      @client
+    end
+  end
+end

data/lib/simplecast/client.rb

@@ -0,0 +1,33 @@
+require 'hurley'
+require 'json'
+require 'simplecast/configurable'
+module Simplecast
+  class Client
+    include Simplecast::Configurable
+    def initialize(options = {})
+      # Use options passed in, but fall back to module defaults
+      Simplecast::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || Simplecast.instance_variable_get(:"@#{key}"))
+      end
+      @client = Hurley::Client.new('https://api.simplecast.fm/v1/')
+      @client.header["X-API-KEY"] = @api_key
+      @client
+    end
+    def request(method, path, data, options = {})
+      if data.is_a?(Hash)
+        options[:query]   = data.delete(:query) || {}
+        options[:headers] = data.delete(:headers) || {}
+        if accept = data.delete(:accept)
+          options[:headers][:accept] = accept
+        end
+      end
+      @last_response = response = @client.send(method, URI::Parser.new.escape(path.to_s), data, options)
+      response.data
+    end
+    def get(url)
+      puts "Log request: #{url.inspect}"
+      response = @client.get(url)
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/simplecast/client/episode.rb

@@ -0,0 +1,23 @@
+module Simplecast
+  class Client
+    module Episode
+      class << self
+        include Simplecast::Client::Resource
+        def find(id, podcast_id = nil)
+          podcast_id ||= client.podcast_id
+          api_obj = client.get("podcasts/#{podcast_id}/episodes/#{id}.json")
+          model.new(api_obj)
+        end
+        def embed(id, podcast_id = nil)
+          podcast_id ||= client.podcast_id
+          api_obj = client.get("podcasts/#{podcast_id}/episodes/#{id}/embed.json")
+        end
+        def all(podcast_id = nil)
+          podcast_id ||= client.podcast_id
+          api_obj_array = client.get("podcasts/#{podcast_id}/episodes.json")
+          api_obj_array.map {|api_obj| model.new(api_obj) }
+        end
+      end
+    end
+  end
+end

data/lib/simplecast/client/podcast.rb

@@ -0,0 +1,9 @@
+module Simplecast
+  class Client
+    module Podcast
+      class << self
+        include Simplecast::Client::Resource 
+      end
+    end
+  end
+end

data/lib/simplecast/client/resource.rb

@@ -0,0 +1,24 @@
+module Simplecast
+  class Client
+    module Resource
+      include Simplecast::Configurable
+      def find(id)
+        api_obj = client.get("#{resource_plural_name_lower}/#{id}.json")
+        model.new(api_obj)
+      end
+      def all
+        all = client.get("#{resource_plural_name_lower}.json")
+        all.map {|item| model.new(item) }
+      end
+      def resource_plural_name_lower
+        send(:name).split('::').last.downcase + "s"
+      end
+      def client
+        @client ||= Simplecast.client
+      end
+      def model
+        Simplecast.const_get(name.split("::").last)
+      end
+    end
+  end
+end

data/lib/simplecast/client/statistic.rb

@@ -0,0 +1,28 @@
+require 'hurley'
+module Simplecast
+  class Client
+    module Statistic
+      class << self
+        include Simplecast::Client::Resource
+        def for_episode(episode_id, podcast_id: nil, opts: {})
+          opts.merge!({episode_id: episode_id})
+          podcast_id ||= client.podcast_id # TODO: || raise Simplecast::Error.new("Podcast ID must be supplied either in configuration or directly to the #for_episode method.")
+          q = Hurley::Query::Flat.new(opts).to_query_string
+          api_obj = client.get("podcasts/#{podcast_id}/statistics/episode.json?#{q}")
+          model.new(api_obj)
+        end
+        def overall(podcast_id: nil, opts: { timeframe: "recent" })
+          podcast_id ||= client.podcast_id
+          q = Hurley::Query::Flat.new(opts).to_query_string
+          api_obj = client.get("podcasts/#{podcast_id}/statistics/overall.json?#{q}")
+          model.new(api_obj)
+        end
+        def all(podcast_id: nil)
+          podcast_id ||= client.podcast_id
+          api_obj_array = client.get("podcasts/#{podcast_id}/statistics.json")
+          api_obj_array.map {|api_obj| model.new(api_obj) }
+        end
+      end
+    end
+  end
+end

data/lib/simplecast/configurable.rb

@@ -0,0 +1,19 @@
+module Simplecast
+  module Configurable
+    attr_accessor :api_key, :podcast_id
+    class << self
+      def keys
+        @keys ||= [
+          :api_key,
+          :podcast_id
+        ]
+      end
+    end
+    def configure
+      yield self
+    end
+    def options
+      Hash[Simplecast::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
+    end
+  end
+end

data/lib/simplecast/episode.rb

@@ -0,0 +1,9 @@
+require 'ostruct'
+module Simplecast
+  class Episode < OpenStruct
+    include Simplecast::Model
+    def embed
+      Simplecast::Client::Episode.embed(id)
+    end
+  end
+end

data/lib/simplecast/model.rb

@@ -0,0 +1,4 @@
+module Simplecast
+  module Model
+  end
+end

data/lib/simplecast/podcast.rb

@@ -0,0 +1,6 @@
+require 'ostruct'
+module Simplecast
+  class Podcast < OpenStruct
+    include Simplecast::Model
+  end
+end

data/lib/simplecast/statistic.rb

@@ -0,0 +1,6 @@
+require 'ostruct'
+module Simplecast
+  class Statistic < OpenStruct
+    include Simplecast::Model
+  end
+end

data/lib/simplecast/version.rb

@@ -0,0 +1,3 @@
+module Simplecast
+  VERSION = "0.0.1"
+end

data/simplecast.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simplecast/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simplecast"
+  spec.version       = Simplecast::VERSION
+  spec.authors       = ["Jonathan Cutrell"]
+  spec.email         = ["jonathan@whiteboard.is"]
+  spec.summary       = %q{Simple wrapper for Simplecast podcasting service.}
+  #spec.description   = %q{}
+  spec.homepage      = "https://github.com/jcutrell/Simplecast"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "hurley", "~> 0.1"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/spec/simplecast/client/episode_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Simplecast::Client::Episode do
+  it "#responds_to :all" do
+    expect(Simplecast::Client::Episode).to respond_to(:all)
+  end
+  it "#responds_to :find" do
+    expect(Simplecast::Client::Episode).to respond_to(:find)
+  end
+end

data/spec/simplecast/client/podcast_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Simplecast::Client::Podcast do
+  it "#responds_to :all" do
+    expect(Simplecast::Client::Podcast).to respond_to(:all)
+  end
+  it "#responds_to :find" do
+    expect(Simplecast::Client::Episode).to respond_to(:find)
+  end
+end

data/spec/simplecast/client/resource_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Simplecast::Client::Resource do
+  before do
+    module Simplecast
+      class Client
+        module Test
+          class << self
+            include Simplecast::Client::Resource
+          end
+        end
+      end
+    end
+  end
+  it "should return the proper resource name" do
+    tc = Simplecast::Client::Test
+    expect(tc.resource_plural_name_lower).to eq("tests")
+  end
+  it "should return an instance of Simplecast::Client" do
+    expect(Simplecast::Client::Test.client).to be_an_instance_of(Simplecast::Client)
+  end
+end

data/spec/simplecast/client_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Simplecast::Client do
+
+  describe "module configuration" do
+
+    before do
+      Simplecast.configure do |c|
+        Simplecast::Configurable.keys.each do |key|
+          c.send("#{key}=", "Some #{key}")
+        end
+      end
+    end
+
+    it "inherits the module configuration" do
+      client = Simplecast::Client.new
+      Simplecast::Configurable.keys.each do |key|
+        expect(client.instance_variable_get(:"@#{key}")).to eq("Some #{key}")
+      end
+    end
+
+  end
+
+end

data/spec/simplecast/episode_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe "Simplecast::Episode" do
+  it "Should respond to embed" do
+    episode = Simplecast::Episode.new
+    expect(episode).to respond_to(:embed)
+  end
+end

data/spec/simplecast/model_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+describe "Simplecast::Model" do
+  before do
+    class Simplecast::TestModel < OpenStruct
+      include Simplecast::Model
+    end
+  end
+  it "Should allow any attributes to be passed to it" do
+    model = Simplecast::TestModel.new({attr_one: "Yes", something_else: "Whatever"})
+    expect(model).to respond_to(:attr_one)
+    expect(model).to respond_to(:something_else)
+    expect(model).not_to respond_to(:foozle)
+    expect(model.attr_one).to eq("Yes")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'simplecast'

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: simplecast
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonathan Cutrell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hurley
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jonathan@whiteboard.is
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simplecast.rb
+- lib/simplecast/client.rb
+- lib/simplecast/client/episode.rb
+- lib/simplecast/client/podcast.rb
+- lib/simplecast/client/resource.rb
+- lib/simplecast/client/statistic.rb
+- lib/simplecast/configurable.rb
+- lib/simplecast/episode.rb
+- lib/simplecast/model.rb
+- lib/simplecast/podcast.rb
+- lib/simplecast/statistic.rb
+- lib/simplecast/version.rb
+- simplecast.gemspec
+- spec/simplecast/client/episode_spec.rb
+- spec/simplecast/client/podcast_spec.rb
+- spec/simplecast/client/resource_spec.rb
+- spec/simplecast/client_spec.rb
+- spec/simplecast/episode_spec.rb
+- spec/simplecast/model_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jcutrell/Simplecast
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Simple wrapper for Simplecast podcasting service.
+test_files:
+- spec/simplecast/client/episode_spec.rb
+- spec/simplecast/client/podcast_spec.rb
+- spec/simplecast/client/resource_spec.rb
+- spec/simplecast/client_spec.rb
+- spec/simplecast/episode_spec.rb
+- spec/simplecast/model_spec.rb
+- spec/spec_helper.rb