leanpub_api 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37bc58a39fa57fd3944ef066cbda7f59948b25e6
-  data.tar.gz: 171a4ae7ebae429ecdddb68e3a0b9ec732c2a815
+  metadata.gz: 4db60a908c6f155cc67f120aa35fdac2dbdd7736
+  data.tar.gz: a300c1be11843a68a5501a26e85a7b3287d5b983
 SHA512:
-  metadata.gz: be1129d41c89d80c54b0810fd266f406dfb767684ddff8686c85c76a00b66adf7de2dfc676f73b0570a67cdce795b86c2399a9b4caee9f92aab8e643786a0e15
-  data.tar.gz: 66083bedd5b5305584f475843a323820fb2ffe7239f503977e9152bd5170095ef13b7542acff520142b61f822a1a3fdbc1082762c144caa7aac6dbb618201784
+  metadata.gz: 4680adc4fbf7edddc3d09475e36588920475df53b55a45986cf805f4c4f508f1fe5da2cf469f31d3db0aa5f54750128a7a90263aa4fd79adcbae277914bb3fd5
+  data.tar.gz: dae321d7683841af5c90149bb6036da0ace3d70b0dfb90e479ed71630d6e644bd80f5844bbcae0466e5a4c91bdd9f199fad3c0219e6a8aaf536d5337ec577d33

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## 0.0.4
+
+- Support for Leanpub book sales summary
+- Refactor HTTP connection stuff to base class
+- Remove warnings about pessimistic dependencies
+
+## 0.0.3
+
+- Initial release
+- Support for Leanpub book summary

data/README.md

@@ -1,6 +1,6 @@
 # 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
+A simple Ruby wrapper for the [Leanpub API](https://leanpub.com/help/api). Currently supports the API's book and sales summary functions, with aspirations to do
 more.
 
 **Disclaimer:** Leanpub is a service of Ruboss Technology Corporation, a
@@ -35,7 +35,7 @@ by [accessing your Leanpub account](https://leanpub.com/dashboard).
 The gem currently supports the Leanpub API's book summary functions.
 
 ```ruby
-require 'leanpub_api_'
+require 'leanpub_api'
 
 book = LeanpubAPI::BookSummary.new('<book-slug>', '<api-key>')
 
@@ -52,6 +52,26 @@ puts book.total_revenue
 puts book.possible_reader_count
 ```
 
+You can also get the sales summary for a Leanpub book.
+
+```ruby
+require 'leanpub_api'
+
+sales = LeanpubAPI::SalesSummary.new('<book-slug>', '<api-key>')
+
+puts sales.book
+puts sales.url
+puts sales.total_author_royalties
+puts sales.total_book_royalties
+puts sales.num_happy_readers
+puts sales.num_happy_paid_purchases
+puts sales.num_refunded_purchases
+puts sales.unpaid_royalties
+puts sales.royalties_currently_due
+puts sales.royalties_due_on_first_of_next_month
+puts sales.paid_royalties
+```
+
 ## Development
 
 Tests expect a `.env` file at the project's root, with the following
@@ -64,14 +84,13 @@ environment variables:
 
 Add wrappers for other API functionality:
 
-- Sales summary
 - All sales data
 - Preview functions
 - Publish functions
 - Preview/publish job status
 - Coupon management
 
-Improve configuration
+Test against other Rubies
 
 ## Contributing
 

data/leanpub_api.gemspec

@@ -18,11 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "httparty", "~> 0.12.0"
+  spec.add_runtime_dependency "httparty", '~> 0.12.0', '>= 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"
+  spec.add_development_dependency "bundler", '~> 1.3'
+  spec.add_development_dependency "rake", '~> 10.1', '>= 10.1.1'
+  spec.add_development_dependency "webmock", '~> 1.14', '>= 1.14.0'
+  spec.add_development_dependency "vcr", '~> 2.6', '>= 2.6.0'
+  spec.add_development_dependency "dotenv", '~> 0.9', '>= 0.9.0'
 end

data/lib/leanpub_api/base.rb

@@ -0,0 +1,25 @@
+module LeanpubAPI
+  class Base
+    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
+  end
+end

data/lib/leanpub_api/book_summary.rb

@@ -1,27 +1,7 @@
 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
-
+  class BookSummary < LeanpubAPI::Base
     private
 
-    def get_info
-      self.class.get(path)
-    end
-
     def path
       "/#{@book_slug}.json?api_key=#{@api_key}"
     end

data/lib/leanpub_api/sales_summary.rb

@@ -0,0 +1,9 @@
+module LeanpubAPI
+  class SalesSummary < LeanpubAPI::Base
+    private
+
+    def path
+      "/#{@book_slug}/sales.json?api_key=#{@api_key}"
+    end
+  end
+end

data/lib/leanpub_api/version.rb

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

data/spec/fixtures/leanpub_cassettes/sales_summary.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://leanpub.com/<LEANPUB_BOOK_SLUG>/sales.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:
+      - Mon, 17 Feb 2014 01:12:04 GMT
+      Etag:
+      - '"64209636cfbe12942dd4c85877804afa"'
+      Server:
+      - nginx + Phusion Passenger 4.0.29
+      Set-Cookie:
+      - AWSELB=BF7915350C754439EF4952CB0CB801868D298314801C9FE6ECB1E0A62F0A1CC471D3F7B3BCEF808A2A657B84781E305B69B23522CD91D8473382F22DEB898C2514173621FE;PATH=/
+      - cookied-flash=%7B%7D; path=/; secure
+      - domain-info=%7B%22root%22%3A%22https%3A%2F%2Fleanpub.com%2F%22%7D; path=/;
+        expires=Tue, 18-Feb-2014 01:12:04 GMT; secure
+      - remember_token=d1248d8ebf3303d1f74c2788df68b618f841c5e2; path=/; expires=Tue,
+        17-Feb-2015 01:12:04 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:
+      - 84ff9ce7201fc68fd7125e2d5b96753b
+      X-Runtime:
+      - '0.126614'
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"book":"<LEANPUB_BOOK_SLUG>","url":"https://leanpub.com/<LEANPUB_BOOK_SLUG>","total_author_royalties":"23456.78","total_book_royalties":"3456.78","num_happy_readers":3534,"num_happy_paid_purchases":3522,"num_refunded_purchases":12,"unpaid_royalties":"1208.75","royalties_currently_due":"0.0","royalties_due_on_first_of_next_month":"1208.75","paid_royalties":"12345.67"}'
+    http_version:
+  recorded_at: Mon, 17 Feb 2014 01:12:25 GMT
+recorded_with: VCR 2.6.0

data/spec/lib/leanpub_api/base_spec.rb

@@ -0,0 +1,13 @@
+require_relative '../../spec_helper'
+
+describe LeanpubAPI::Base 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
+end

data/spec/lib/leanpub_api/book_summary_spec.rb

@@ -1,16 +1,6 @@
 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) }
 

data/spec/lib/leanpub_api/sales_summary_spec.rb

@@ -0,0 +1,66 @@
+require_relative '../../spec_helper'
+
+describe LeanpubAPI::SalesSummary do
+  describe "GET sales summary info" do
+    let(:summary) { LeanpubAPI::SalesSummary.new(book_slug, api_key) }
+
+    before :each do
+      VCR.insert_cassette 'sales_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["book"].must_equal "everydayrailsrspec"
+      summary.info["url"].must_equal "https://leanpub.com/everydayrailsrspec"
+      summary.info["total_author_royalties"].must_equal "23456.78"
+      summary.info["total_book_royalties"].must_equal "3456.78"
+      summary.info["num_happy_readers"].must_equal 3534
+      summary.info["num_happy_paid_purchases"].must_equal 3522
+      summary.info["num_refunded_purchases"].must_equal 12
+      summary.info["unpaid_royalties"].must_equal "1208.75"
+      summary.info["royalties_currently_due"].must_equal "0.0"
+      summary.info["royalties_due_on_first_of_next_month"].must_equal "1208.75"
+      summary.info["paid_royalties"].must_equal "12345.67"
+    end
+
+    describe "dynamic attributes" do
+      before do
+        summary.info
+      end
+
+      it "returns an attribute if present in the info" do
+        summary.num_happy_readers.must_equal 3534
+      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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leanpub_api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Aaron Sumner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-13 00:00:00.000000000 Z
+date: 2014-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -17,6 +17,9 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.12.0
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.12.0
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -43,6 +49,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+    - - '>='
       - !ruby/object:Gem::Version
         version: 10.1.1
   type: :development
@@ -50,6 +59,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+    - - '>='
       - !ruby/object:Gem::Version
         version: 10.1.1
 - !ruby/object:Gem::Dependency
@@ -57,6 +69,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.14'
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.14.0
   type: :development
@@ -64,6 +79,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.14'
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.14.0
 - !ruby/object:Gem::Dependency
@@ -71,6 +89,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.6.0
   type: :development
@@ -78,6 +99,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.6.0
 - !ruby/object:Gem::Dependency
@@ -85,6 +109,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :development
@@ -92,6 +119,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.9.0
 description: A simple Ruby wrapper for the Leanpub API.
@@ -102,16 +132,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - leanpub_api.gemspec
 - lib/leanpub_api.rb
+- lib/leanpub_api/base.rb
 - lib/leanpub_api/book_summary.rb
+- lib/leanpub_api/sales_summary.rb
 - lib/leanpub_api/version.rb
 - spec/fixtures/leanpub_cassettes/book_summary.yml
+- spec/fixtures/leanpub_cassettes/sales_summary.yml
+- spec/lib/leanpub_api/base_spec.rb
 - spec/lib/leanpub_api/book_summary_spec.rb
+- spec/lib/leanpub_api/sales_summary_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/ruralocity/leanpub-api
 licenses:
@@ -140,5 +176,8 @@ summary: A simple Ruby wrapper for the Leanpub API. Not affiliated with Leanpub
   Ruboss Technology Corporation.
 test_files:
 - spec/fixtures/leanpub_cassettes/book_summary.yml
+- spec/fixtures/leanpub_cassettes/sales_summary.yml
+- spec/lib/leanpub_api/base_spec.rb
 - spec/lib/leanpub_api/book_summary_spec.rb
+- spec/lib/leanpub_api/sales_summary_spec.rb
 - spec/spec_helper.rb