honeycrisp 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 262039adf9839c205736ed3c2b0b7f07152aa2a1
+  data.tar.gz: 0a36b9e5a8161e54515fbe95c52562586ce12260
+SHA512:
+  metadata.gz: c7d7f2e0f46b62f07e46b50bf3c631137e189d780cd4789192b863a1c84e01bfa821bbfd44aaff20d0fcb5a93acce851fdb52c1100a427ae61c66d98d9ce9511
+  data.tar.gz: 64d2f6d6cbf92341357587bed6fd3e4e6a7338bafeab97ee26b84d3762a558d8dc2deadfe4e7cb0b4bc754a467b870d2dfca261d8d9bb36e240083de30cb5821

data/.gitignore

@@ -0,0 +1,39 @@
+*.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
+/vendor/ruby
+/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
+
+## OSX
+.DS_Store

data/CHANGES.md

@@ -0,0 +1,7 @@
+Version 0.0.1
+-------------
+
+Released February 17, 2015
+
+- Initial release.
+- Supports basic receipt validation.

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rake', '~> 10.1'
+  gem 'rspec', '~> 3.0'
+  gem 'fakeweb', '~> 1.3'
+  gem 'rack', '~> 1.3'
+end

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2015 Justin Rhinesmith.
+
+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/Makefile

@@ -0,0 +1,8 @@
+install:
+	bundle exec rake install
+
+test-install:
+	bundle install
+
+test:
+	bundle exec rake spec

data/README.md

@@ -0,0 +1,69 @@
+# honeycrisp
+
+A module for validating receipts with Apple's App Store. [Click here to read the full documentation.][documentation]
+
+## Installation
+
+To install using [Bundler][bundler] grab the latest stable version:
+
+```ruby
+gem 'honeycrisp', '~> 0.0.1'
+```
+
+To manually install `honeycrisp` via [Rubygems][rubygems] simply gem install:
+
+```bash
+gem install honeycrisp
+```
+
+To build and install the development branch yourself from the latest source:
+
+```bash
+git clone git@github.com:jerhinesmith/honeycrisp.git
+cd honeycrisp
+make install
+```
+
+## Getting Started With Honeycrisp
+
+### Setup Work
+
+``` ruby
+require 'rubygems' # not necessary with ruby 1.9 but included for completeness
+require 'honeycrisp'
+
+# put your own credentials here
+shared_secret = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+
+# set up a client to talk to the App Store
+@client = Honeycrisp::Client.new shared_secret, use_sandbox: true
+
+# alternatively, you can preconfigure the client like so
+Honeycrisp.configure do |config|
+  config.shared_secret = shared_secret
+  config.use_sandbox = true
+end
+
+# and then you can create a new client without parameters
+@client = Honeycrisp::Client.new
+```
+
+### Validate a receipt
+
+``` ruby
+receipt = @client.validate_receipt(base64_encoded_string)
+```
+
+## Supported Ruby Versions
+
+This library supports has been manually tested agains the following Ruby
+implementations:
+
+- Ruby 2.1.0
+
+## More Information
+
+[bundler]: http://bundler.io
+[rubygems]: http://rubygems.org
+[gem]: https://rubygems.org/gems/honeycrisp
+[documentation]: https://developer.apple.com/library/ios/releasenotes/General/ValidateAppStoreReceipt/Chapters/ValidateRemotely.html#//apple_ref/doc/uid/TP40010573-CH104-SW1

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+task test: :spec

data/honeycrisp.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'honeycrisp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'honeycrisp'
+  spec.version       = Honeycrisp::VERSION
+  spec.authors       = ['Justin Rhinesmith']
+  spec.email         = ['jerhinesmith@gmail.com']
+  spec.summary       = "A simple library for communicating with Apple's iTunes receipt validation server."
+  spec.description   = "A simple library for communicating with Apple's iTunes receipt validation server."
+  spec.homepage      = 'http://github.com/jerhinesmith/honeycrisp'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.extra_rdoc_files = ['README.md', 'LICENSE.md']
+  spec.rdoc_options = ['--line-numbers', '--inline-source', '--title', 'honeycrisp', '--main', 'README.md']
+
+  spec.add_dependency 'faraday', ['>= 0.8', '< 0.10']
+  spec.add_dependency 'multi_json', '>= 1.3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.extra_rdoc_files = ['README.md', 'LICENSE.md']
+  spec.rdoc_options = ['--line-numbers', '--inline-source', '--title', 'honeycrisp', '--main', 'README.md']
+end

data/lib/honeycrisp.rb

@@ -0,0 +1,10 @@
+require File.join(File.dirname(__FILE__), 'honeycrisp', 'version')
+require File.join(File.dirname(__FILE__), 'honeycrisp', 'configuration')
+require File.join(File.dirname(__FILE__), 'honeycrisp', 'client')
+require File.join(File.dirname(__FILE__), 'honeycrisp', 'receipt')
+require File.join(File.dirname(__FILE__), 'honeycrisp', 'in_app_purchase')
+require File.join(File.dirname(__FILE__), 'honeycrisp', 'itunes', 'error')
+
+module Honeycrisp
+  extend Configuration
+end

data/lib/honeycrisp/client.rb

@@ -0,0 +1,56 @@
+require 'faraday'
+require 'logger'
+require 'multi_json'
+
+module Honeycrisp
+  class Client
+    HTTP_HEADERS = {
+      'Accept' => 'application/json',
+      'Content-Type' => 'application/json',
+      'Accept-Charset' => 'utf-8',
+      'User-Agent' => "honeycrisp/#{Honeycrisp::VERSION}" \
+                      " (#{RUBY_ENGINE}/#{RUBY_PLATFORM}" \
+                      " #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL})"
+    }
+
+    attr_reader :shared_secret, :use_sandbox
+
+    def initialize(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+
+      @shared_secret  = args[0] || Honeycrisp.shared_secret
+      @use_sandbox    = options.fetch(:use_sandbox, Honeycrisp.use_sandbox)
+
+      raise ArgumentError, 'Shared secret is required' if @shared_secret.nil?
+    end
+
+    def host
+      use_sandbox ? 'https://sandbox.itunes.apple.com' : 'https://buy.itunes.apple.com'
+    end
+
+    def validate_receipt(base64_receipt)
+      connection.response :logger, ::Logger.new($stdout) if ENV['HONEYCRISP_DEBUG'] == 'true'
+
+      params = {
+        'receipt-data'  => base64_receipt,
+        'password'      => shared_secret
+      }
+
+      response = connection.post do |request|
+        request.url '/verifyReceipt'
+        request.headers.merge!(HTTP_HEADERS)
+        request.body = MultiJson.dump(params)
+      end
+
+      Honeycrisp::Receipt.new(MultiJson.load(response.body))
+    end
+
+    private
+    def connection
+      @connection ||= Faraday.new(url: host) do |faraday|
+        faraday.request  :url_encoded             # form-encode POST params
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+    end
+  end
+end

data/lib/honeycrisp/configuration.rb

@@ -0,0 +1,18 @@
+module Honeycrisp
+  module Configuration
+    attr_accessor :shared_secret, :use_sandbox
+
+    def configure
+      yield self
+    end
+
+    def self.extended(base)
+      base.set_default_configuration
+    end
+
+    def set_default_configuration
+      self.shared_secret  = ''
+      self.use_sandbox    = true
+    end
+  end
+end

data/lib/honeycrisp/in_app_purchase.rb

@@ -0,0 +1,23 @@
+module Honeycrisp
+  class InAppPurchase
+    attr_accessor :quantity, :product_id, :transaction_id, :original_transaction_id,
+                  :purchase_date_ms, :original_purchase_date_ms, :is_trial_period
+
+    def initialize(attributes = {})
+      attributes.each do |k, v|
+        send("#{k}=", v) if respond_to?("#{k}=".to_sym)
+      end
+
+      # Return self
+      self
+    end
+
+    def purchase_date
+      Time.at(purchase_date_ms.to_i / 1000).utc
+    end
+
+    def original_purchase_date
+      Time.at(original_purchase_date_ms.to_i / 1000).utc
+    end
+  end
+end

data/lib/honeycrisp/itunes/error.rb

@@ -0,0 +1,24 @@
+module Honeycrisp
+  module Itunes
+    CODES = {
+      21000 => "The App Store could not read the JSON object you provided.",
+      21002 => "The data in the receipt-data property was malformed or missing.",
+      21003 => "The receipt could not be authenticated.",
+      21004 => "The shared secret you provided does not match the shared secret on file for your account.",
+      21005 => "The receipt server is not currently available.",
+      21006 => "This receipt is valid but the subscription has expired. When this status code is returned to your server, the receipt data is also decoded and returned as part of the response.",
+      21007 => "This receipt is from the test environment, but it was sent to the production environment for verification. Send it to the test environment instead.",
+      21008 => "This receipt is from the production environment, but it was sent to the test environment for verification. Send it to the production environment instead."
+    }
+
+    class Error
+      attr_accessor :code
+      attr_reader :description
+
+      def initialize(code, description = nil)
+        @code         = code
+        @description  = description || Honeycrisp::Itunes::CODES[code]
+      end
+    end
+  end
+end

data/lib/honeycrisp/receipt.rb

@@ -0,0 +1,70 @@
+module Honeycrisp
+  class Receipt
+    # Meta fields
+    attr_accessor :status, :environment, :raw
+
+    # Receipt fields
+    attr_accessor :receipt_type, :app_item_id, :bundle_id, :application_version,
+                  :version_external_identifier, :original_purchase_date_ms,
+                  :original_application_version, :latest_receipt
+
+    attr_reader   :in_app_purchases, :subscriptions, :errors
+
+    def initialize(receipt_hash)
+      # Initialize the errors array
+      @in_app_purchases, @subscriptions = [], []
+
+      # Set the meta-fields
+      self.raw            = receipt_hash
+      self.status         = receipt_hash['status'].to_i
+      self.environment    = receipt_hash['environment']
+      self.latest_receipt = receipt_hash['latest_receipt']
+
+      # Set the receipt fields
+      receipt       = receipt_hash.fetch('receipt', {})
+      subscriptions = receipt_hash.fetch('latest_receipt_info', [])
+      purchases     = receipt.fetch('in_app', [])
+
+      receipt.each do |k, v|
+        send("#{k}=", v) if respond_to?("#{k}=".to_sym)
+      end
+
+      purchases.each do |purchase_hash|
+        @in_app_purchases << Honeycrisp::InAppPurchase.new(purchase_hash)
+      end
+
+      subscriptions.each do |subscription_hash|
+        @subscriptions << Honeycrisp::Subscription.new(subscription_hash)
+      end
+
+      @in_app_purchases.sort_by{ |s| s.purchase_date_ms.to_i }
+      @subscriptions.sort_by{ |s| s.expires_date_ms.to_i }
+
+      # Return self
+      self
+    end
+
+    def original_purchase_date
+      Time.at(original_purchase_date_ms.to_i / 1000).utc
+    end
+
+    def latest_purchase
+      @in_app_purchases.last
+    end
+
+    def latest_subscription
+      @subscriptions.last
+    end
+
+    def valid?
+      # Clear out any errors so we can revalidate
+      @errors = []
+
+      # Check the status
+      @errors << Honeycrisp::Itunes::Error.new(self.status) if self.status != 0
+
+      # Valid if errors array is empty
+      @errors.length == 0
+    end
+  end
+end

data/lib/honeycrisp/subscription.rb

@@ -0,0 +1,13 @@
+module Honeycrisp
+  class Subscription < InAppPurchase
+    attr_accessor :expires_date_ms
+
+    def expires_date
+      Time.at(expires_date_ms.to_i / 1000).utc
+    end
+
+    def expired?
+      Time.now.utc > expires_date
+    end
+  end
+end

data/lib/honeycrisp/version.rb

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

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: honeycrisp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Justin Rhinesmith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: A simple library for communicating with Apple's iTunes receipt validation
+  server.
+email:
+- jerhinesmith@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.md
+files:
+- ".gitignore"
+- CHANGES.md
+- Gemfile
+- LICENSE.md
+- Makefile
+- README.md
+- Rakefile
+- honeycrisp.gemspec
+- lib/honeycrisp.rb
+- lib/honeycrisp/client.rb
+- lib/honeycrisp/configuration.rb
+- lib/honeycrisp/in_app_purchase.rb
+- lib/honeycrisp/itunes/error.rb
+- lib/honeycrisp/receipt.rb
+- lib/honeycrisp/subscription.rb
+- lib/honeycrisp/version.rb
+- spec/.gitkeep
+homepage: http://github.com/jerhinesmith/honeycrisp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--line-numbers"
+- "--inline-source"
+- "--title"
+- honeycrisp
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+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 library for communicating with Apple's iTunes receipt validation
+  server.
+test_files:
+- spec/.gitkeep