leanpub_api 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37bc58a39fa57fd3944ef066cbda7f59948b25e6
+  data.tar.gz: 171a4ae7ebae429ecdddb68e3a0b9ec732c2a815
+SHA512:
+  metadata.gz: be1129d41c89d80c54b0810fd266f406dfb767684ddff8686c85c76a00b66adf7de2dfc676f73b0570a67cdce795b86c2399a9b4caee9f92aab8e643786a0e15
+  data.tar.gz: 66083bedd5b5305584f475843a323820fb2ffe7239f503977e9152bd5170095ef13b7542acff520142b61f822a1a3fdbc1082762c144caa7aac6dbb618201784

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.env

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Aaron Sumner
+
+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,82 @@
+# Leanpub API wrapper for Ruby
+
+A simple Ruby wrapper for the [Leanpub API](https://leanpub.com/help/api). Currently supports the API's book summary functions, with aspirations to do
+more.
+
+**Disclaimer:** Leanpub is a service of Ruboss Technology Corporation, a
+corporation incorporated in British Columbia, Canada. I self-publish a book
+using their service, but am otherwise not affiliated with them in any way.
+
+## Requirements
+
+This library has been tested against the following Ruby versions:
+
+- 2.0.0
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'leanpub_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install leanpub_api
+
+## Usage
+
+You'll need your book slug and API key values, both of which can be retrieved
+by [accessing your Leanpub account](https://leanpub.com/dashboard).
+
+The gem currently supports the Leanpub API's book summary functions.
+
+```ruby
+require 'leanpub_api_'
+
+book = LeanpubAPI::BookSummary.new('<book-slug>', '<api-key>')
+
+puts book.title
+puts book.subtitle
+puts book.slug
+puts book.author_string
+puts book.url
+puts book.title_page_url
+puts book.minimum_price
+puts book.suggested_price
+puts book.total_copies_sold
+puts book.total_revenue
+puts book.possible_reader_count
+```
+
+## Development
+
+Tests expect a `.env` file at the project's root, with the following
+environment variables:
+
+- `LEANPUB_BOOK_SLUG` Your book's Leanpub slug
+- `LEANPUB_API_KEY` Your Leanpub API key
+
+## TODO
+
+Add wrappers for other API functionality:
+
+- Sales summary
+- All sales data
+- Preview functions
+- Publish functions
+- Preview/publish job status
+- Coupon management
+
+Improve configuration
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes, with tests (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/lib/leanpub_api/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/leanpub_api.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'leanpub_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "leanpub_api"
+  spec.version       = LeanpubAPI::VERSION
+  spec.authors       = ["Aaron Sumner"]
+  spec.email         = ["asumner@mac.com"]
+  spec.description   = %q{A simple Ruby wrapper for the Leanpub API.}
+  spec.summary       = %q{A simple Ruby wrapper for the Leanpub API. Not affiliated with Leanpub or Ruboss Technology Corporation.}
+  spec.homepage      = "https://github.com/ruralocity/leanpub-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "httparty", "~> 0.12.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.1.1"
+  spec.add_development_dependency "webmock", "~> 1.14.0"
+  spec.add_development_dependency "vcr", "~> 2.6.0"
+  spec.add_development_dependency "dotenv", "~> 0.9.0"
+end

data/lib/leanpub_api/book_summary.rb

@@ -0,0 +1,29 @@
+module LeanpubAPI
+  class BookSummary
+    include HTTParty
+    base_uri 'https://leanpub.com'
+
+    def initialize(book_slug, api_key)
+      @book_slug = book_slug
+      @api_key = api_key
+    end
+
+    def info(force = false)
+      force ? @info = get_info : @info ||= get_info
+    end
+
+    def method_missing(name, *args, &block)
+      info.has_key?(name.to_s) ? info[name.to_s] : super
+    end
+
+    private
+
+    def get_info
+      self.class.get(path)
+    end
+
+    def path
+      "/#{@book_slug}.json?api_key=#{@api_key}"
+    end
+  end
+end

data/lib/leanpub_api/version.rb

@@ -0,0 +1,3 @@
+module LeanpubAPI
+  VERSION = "0.0.3"
+end

data/lib/leanpub_api.rb

@@ -0,0 +1,8 @@
+require "leanpub_api/version"
+require "httparty"
+
+module LeanpubAPI
+  Dir[File.dirname(__FILE__) + '/leanpub_api/*.rb'].each do |file|
+    require file
+  end
+end

data/spec/fixtures/leanpub_cassettes/book_summary.yml

@@ -0,0 +1,61 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://leanpub.com/<LEANPUB_BOOK_SLUG>.json?api_key=<LEANPUB_API_KEY>
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      - no-cache="set-cookie"
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Thu, 13 Feb 2014 05:42:21 GMT
+      Etag:
+      - '"1ad41ab72329fc3914991bdc9c94ae44"'
+      Server:
+      - nginx + Phusion Passenger 4.0.29
+      Set-Cookie:
+      - AWSELB=BF7915350C754439EF4952CB0CB801868D298314801C9FE6ECB1E0A62F0A1CC471D3F7B3BC89A85AAC39AEABF40B5E0269382C4B41DE08103BD974E66E11B0D967B3BF599E;PATH=/
+      - _lpub_session=BAh7BkkiD3Nlc3Npb25faWQGOgZFRkkiJTJlNTczNGU1YmVkNzU4ZTg4MTA5MmI5ODRjYTM1NjBhBjsAVA%3D%3D--8e1db4d52cb04c458d447acd0e92ddb5c7c071b9;
+        path=/; secure; HttpOnly
+      - cookied-flash=%7B%7D; path=/; secure
+      - domain-info=%7B%22root%22%3A%22https%3A%2F%2Fleanpub.com%2F%22%7D; path=/;
+        expires=Fri, 14-Feb-2014 05:42:21 GMT; secure
+      - remember_token=d1248d8ebf3303d1f74c2788df68b618f841c5e2; path=/; expires=Fri,
+        13-Feb-2015 05:42:21 GMT; secure
+      - user-info=; path=/; expires=Thu, 01-Jan-1970 00:00:00 GMT; secure
+      Status:
+      - 200 OK
+      Strict-Transport-Security:
+      - max-age=31536000
+      X-Powered-By:
+      - Phusion Passenger 4.0.29
+      X-Rack-Cache:
+      - miss
+      X-Request-Id:
+      - b65392997af166ca2d77300fe819d548
+      X-Runtime:
+      - '0.059839'
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Content-Length:
+      - '443'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"slug":"<LEANPUB_BOOK_SLUG>","subtitle":"A practical approach to test-driven
+        development","title":"Everyday Rails Testing with RSpec","total_copies_sold":3513,"total_revenue":"12345.67","author_string":"Aaron
+        Sumner","url":"http://leanpub.com/<LEANPUB_BOOK_SLUG>","title_page_url":"https://s3.amazonaws.com/titlepages.leanpub.com/<LEANPUB_BOOK_SLUG>/original?1392171401","minimum_price":"14.0","suggested_price":"19.0","possible_reader_count":12}'
+    http_version:
+  recorded_at: Thu, 13 Feb 2014 05:41:53 GMT
+recorded_with: VCR 2.6.0

data/spec/lib/leanpub_api/book_summary_spec.rb

@@ -0,0 +1,72 @@
+require_relative '../../spec_helper'
+
+describe LeanpubAPI::BookSummary do
+  describe "default attributes" do
+    it "include HTTParty methods" do
+      LeanpubAPI::BookSummary.must_include HTTParty
+    end
+
+    it "have the base URL set to the Leanpub API endpoint" do
+      LeanpubAPI::BookSummary.base_uri.must_equal 'https://leanpub.com'
+    end
+  end
+
+  describe "GET book info" do
+    let(:summary) { LeanpubAPI::BookSummary.new(book_slug, api_key) }
+
+    before :each do
+      VCR.insert_cassette 'book_summary', record: :new_episodes
+    end
+
+    after :each do
+      VCR.eject_cassette
+    end
+
+    it "has data" do
+      summary.must_respond_to :info
+    end
+
+    it "parses the JSON response to a hash" do
+      summary.info.must_be_instance_of Hash
+    end
+
+    it "performs the request and gets the data" do
+      summary.info["author_string"].must_equal "Aaron Sumner"
+      summary.info["title"].must_equal "Everyday Rails Testing with RSpec"
+      summary.info["subtitle"].must_equal "A practical approach to test-driven development"
+      summary.info["total_copies_sold"].must_equal 3513
+      summary.info["total_revenue"].must_equal "12345.67"
+      summary.info["minimum_price"].must_equal "14.0"
+      summary.info["suggested_price"].must_equal "19.0"
+    end
+
+    describe "dynamic attributes" do
+      before do
+        summary.info
+      end
+
+      it "returns an attribute if present in the info" do
+        summary.title.must_equal "Everyday Rails Testing with RSpec"
+      end
+
+      it "raises method missing if an attribute is not present in the info" do
+        lambda { summary.bad_attribute }.must_raise NoMethodError
+      end
+    end
+
+    describe "caching" do
+      before do
+        summary.info
+        stub_request(:any, /leanpub.com/).to_timeout
+      end
+
+      it "caches the info" do
+        summary.info.must_be_instance_of Hash
+      end
+
+      it "refreshes the info if forced" do
+        lambda { summary.info(true) }.must_raise Timeout::Error
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require_relative '../lib/leanpub_api'
+
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'vcr'
+require 'dotenv'
+
+Dotenv.load
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/fixtures/leanpub_cassettes'
+  config.hook_into :webmock
+
+  config.filter_sensitive_data("<LEANPUB_BOOK_SLUG>") do
+    book_slug
+  end
+
+  config.filter_sensitive_data("<LEANPUB_API_KEY>") do
+    api_key
+  end
+end
+
+def book_slug
+  ENV.fetch 'LEANPUB_BOOK_SLUG'
+end
+
+def api_key
+  ENV.fetch 'LEANPUB_API_KEY'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: leanpub_api
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Aaron Sumner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.14.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: A simple Ruby wrapper for the Leanpub API.
+email:
+- asumner@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- leanpub_api.gemspec
+- lib/leanpub_api.rb
+- lib/leanpub_api/book_summary.rb
+- lib/leanpub_api/version.rb
+- spec/fixtures/leanpub_cassettes/book_summary.yml
+- spec/lib/leanpub_api/book_summary_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ruralocity/leanpub-api
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A simple Ruby wrapper for the Leanpub API. Not affiliated with Leanpub or
+  Ruboss Technology Corporation.
+test_files:
+- spec/fixtures/leanpub_cassettes/book_summary.yml
+- spec/lib/leanpub_api/book_summary_spec.rb
+- spec/spec_helper.rb