apple-news 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 703b6211a92ccabe31c718641e2cb15d79782614
+  data.tar.gz: 8f10ed6f53c56d308aa0d028b78c4590b11007c7
+SHA512:
+  metadata.gz: 4e24363fdc8a83fa956528471e6452d925cc67766f14d0f6b757f0221acb5ef8e9b5e35f45f89a0c373b1e834fcb7588a1bc1d8af3f7e09a00e60f08c3753820
+  data.tar.gz: b9d5d00d7c16762cddefb3fb7830ee350ad9ef758367421b31947f7d69be22ea38b0d3191f640de81bb30f77e9e72da843b095d6e2de031d829f06bdda071756

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+test.rb

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,138 @@
+# Apple News
+
+A fully featured gem for building Apple News documents and interfacing with the Apple News API.
+
+**NOTE:** this is very much a work in progress. There are a lot of things that don't work yet, and some things will probbaly change (even drastically), but the basics are here. You can create and fetch articles, and fetch information about channels and sections.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'apple-news'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install apple-news
+
+## Configuration
+
+In order to work with the Apple News API, we have to set a couple of configuration params that are available from [News Publisher](https://www.icloud.com/#newspublisher).
+
+``` ruby
+AppleNews.config.channel_id = "63aFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF"
+AppleNews.config.api_key_id = "379FFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF"
+AppleNews.config.api_key_secret = "miJAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA="
+```
+
+## Fetching Data
+
+### Channels
+
+You can fetch the Channel information by calling:
+
+``` ruby
+channel = AppleNews::Channel.current
+```
+
+Because each channel has a separate API key, there is only ever one channel that you can fetch.
+
+### Sections
+
+You can either fetch sections by their ID, or by fetching all of them through the Channel object.
+
+``` ruby
+section = AppleNews::Section.new(section_id)
+
+# or
+channel = AppleNews::Channel.current
+channel.default_section # for the default section
+channel.sections # for all the sections
+```
+
+### Articles
+
+You can fetch articles either by their ID, their channel, or their section.
+
+``` ruby
+article = AppleNews::Article.new(article_id)
+
+# or
+channel = AppleNews::Channel.current
+channel.articles # all articles in the channel
+channel.default_section.articles # all articles in the default section
+```
+
+## Submitting Articles
+
+Apple News articles are submitted as "bundles", with the article content and attached files together in one request. Because of this, we have the concept of a Document. The Document is the high-level abstraction that contains all of the contents for submission to the Apple News API, as well as the extra metadata that lets us control things like setting whether the article is just a preview or if it's sponsored.
+
+### Building Articles
+
+Articles are built using the `AppleNews::Article` class. All articles must have an identifier (a string generated by you to determine article uniqueness, not the ID returned from the Apple News API), title, layout, components, and a default component text style.
+
+In order to maintain idiomatic Ruby, all properties are accessed/set via the underscore version of the actual Apple News API property. For example, `componentTextStyles` becomes `component_text_styles`.
+
+``` ruby
+article = AppleNews::Article.new
+article.identifier = "1234"
+article.title = "Test Article"
+article.layout = AppleNews::Layout.new(columns: 1, width: 1024)
+article.component_text_styles[:default] = AppleNews::Style::ComponentText.new(
+  font_name: 'Georgia',
+  font_size: 14,
+  text_color: '#000000'
+)
+
+article.components << AppleNews::Component::Heading.new(text: "Test Article")
+article.components << AppleNews::Component::Body.new(text: "Just testing out this Ruby gem!")
+```
+
+Every component, style, property, etc. as defined by the [API documentation](https://developer.apple.com/library/ios/documentation/General/Conceptual/Apple_News_Format_Ref/index.html) has its own class. Each property can be set either by the constructor, or by calling the accessor method on the object. For example:
+
+``` ruby
+AppleNews::Component::Instagram.new(url: 'https://www.instagram.com/p/BB7mr0hsS4U/')
+
+# or
+
+component = AppleNews::Component::Instagram.new
+component.url = "https://www.instagram.com/p/BB7mr0hsS4U/"
+```
+
+### Creating a Document
+
+A document must have an article. Once it's created, you can set metadata flags and add files to the document bundle.
+
+``` ruby
+document = AppleNews::Document.new(article)
+document.is_preview = true
+
+# There are 3 different ways you can add a file to the document
+document.add_file(File.new("/path/to/image.jpg"))
+document.add_file_at_path("/path/to/image.jpg")
+document.add_string_as_file("image.jpg", image_contents, "image/jpeg")
+```
+
+### Saving a Document
+
+Once you have your document built, you can submit it to the API.
+
+```
+document.save!
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hodinkee/apple-news-rb.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/apple-news.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apple-news/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "apple-news"
+  spec.version       = AppleNews::VERSION
+  spec.authors       = ["Ryan LeFevre"]
+  spec.email         = ["ryan@hodinkee.com"]
+
+  spec.summary       = %q{Fully-featured library for working with the Apple News API.}
+  spec.description   = %q{Fully-featured library for fetching and creating content with the Apple News API.}
+  spec.homepage      = "https://github.com/hodinkee/apple-news-rb"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "multipart-post"
+  spec.add_dependency "mime-types", ">= 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "apple/news"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/apple-news.rb

@@ -0,0 +1,41 @@
+require 'active_support/core_ext/hash/indifferent_access'
+require "active_support/concern"
+require "active_support/core_ext/class/attribute"
+require "active_support/core_ext/string/inflections"
+
+require "base64"
+require "json"
+require 'net/http/post/multipart'
+require 'apple-news/multipart_post_patch'
+require "mime/types"
+
+require "apple-news/version"
+require "apple-news/properties"
+require "apple-news/addition"
+require "apple-news/animation"
+require "apple-news/behavior"
+require "apple-news/component"
+require "apple-news/component_layout"
+require "apple-news/layout"
+require "apple-news/metadata"
+require "apple-news/property"
+require "apple-news/scene"
+require "apple-news/style"
+
+require "apple-news/resource"
+require "apple-news/links"
+require "apple-news/configuration"
+require "apple-news/document"
+require "apple-news/article"
+require "apple-news/channel"
+require "apple-news/request"
+require "apple-news/section"
+require "apple-news/security"
+
+module AppleNews
+  extend self
+
+  def config
+    @config ||= Configuration.new
+  end
+end

data/lib/apple-news/addition.rb

@@ -0,0 +1,7 @@
+require 'apple-news/additions/base'
+Dir["#{File.dirname(__FILE__)}/additions/*.rb"].each { |path| require path }
+
+module AppleNews
+  module Addition
+  end
+end

data/lib/apple-news/additions/base.rb

@@ -0,0 +1,15 @@
+module AppleNews
+  module Addition
+    class Base
+      include Properties
+
+      def self.type(val = nil)
+        val.nil? ? _required_property_map[:type] : required_property(:type, val)
+      end
+
+      def type
+        self.class.type
+      end
+    end
+  end
+end

data/lib/apple-news/additions/link.rb

@@ -0,0 +1,9 @@
+module AppleNews
+  module Addition
+    class Link < Base
+      type "link"
+      required_properties :range_length, :range_start, :url
+      property_inflection :url, 'URL'
+    end
+  end
+end

data/lib/apple-news/animation.rb

@@ -0,0 +1,7 @@
+require 'apple-news/animations/base'
+Dir["#{File.dirname(__FILE__)}/animations/*.rb"].each { |path| require path }
+
+module AppleNews
+  module Animation
+  end
+end

data/lib/apple-news/animations/appear.rb

@@ -0,0 +1,7 @@
+module AppleNews
+  module Animation
+    class Appear < Base
+      type "appear"
+    end
+  end
+end

data/lib/apple-news/animations/base.rb

@@ -0,0 +1,17 @@
+module AppleNews
+  module Animation
+    class Base
+      include Properties
+
+      optional_property :user_controllable
+
+      def self.type(val = nil)
+        val.nil? ? _required_property_map[:type] : required_property(:type, val)
+      end
+
+      def type
+        self.class.type
+      end
+    end
+  end
+end

data/lib/apple-news/animations/fade_in.rb

@@ -0,0 +1,8 @@
+module AppleNews
+  module Animation
+    class FadeIn < Base
+      type "fade_in"
+      optional_property :initial_alpha
+    end
+  end
+end

data/lib/apple-news/animations/move_in.rb

@@ -0,0 +1,8 @@
+module AppleNews
+  module Animation
+    class MoveIn < Base
+      type "move_in"
+      optional_property :preferred_starting_position
+    end
+  end
+end

data/lib/apple-news/animations/scale_fade.rb

@@ -0,0 +1,8 @@
+module AppleNews
+  module Animation
+    class ScaleFade < Base
+      type "scale_fade"
+      optional_properties :initial_alpha, :initial_scale
+    end
+  end
+end

data/lib/apple-news/article.rb

@@ -0,0 +1,33 @@
+module AppleNews
+  class Article
+    include Resource
+    include Properties
+
+    attr_reader :id
+
+    required_properties :identifier, :title, :layout
+    required_property :components, []
+    required_property :component_text_styles, {}
+
+    required_property :version, "1.1"
+    required_property :language, "en"
+
+    optional_properties :advertising_settings, :subtitle, :metadata, :document_style,
+                        :text_styles, :component_layouts, :component_styles
+
+    def initialize(id = nil, opts = nil)
+      super(opts)
+
+      @id = id
+      @url = "/articles/#{id}"
+      @metadata = Metadata.new((opts || {}).fetch(:metadata, {}))
+
+      hydrate! if !id.nil? && opts.nil?
+    end
+
+    def persisted?
+      !@id.nil?
+    end
+    alias_method :saved?, :persisted?
+  end
+end

data/lib/apple-news/behavior.rb

@@ -0,0 +1,7 @@
+require 'apple-news/behaviors/base'
+Dir["#{File.dirname(__FILE__)}/behaviors/*.rb"].each { |path| require path }
+
+module AppleNews
+  module Behavior
+  end
+end

data/lib/apple-news/behaviors/background_motion.rb

@@ -0,0 +1,7 @@
+module AppleNews
+  module Behavior
+    class BackgroundMotion < Base
+      type "background_motion"
+    end
+  end
+end

data/lib/apple-news/behaviors/background_parallax.rb

@@ -0,0 +1,7 @@
+module AppleNews
+  module Behavior
+    class BackgroundParallax < Base
+      type "background_parallax"
+    end
+  end
+end

data/lib/apple-news/behaviors/base.rb

@@ -0,0 +1,15 @@
+module AppleNews
+  module Behavior
+    class Base
+      include Properties
+
+      def self.type(val = nil)
+        val.nil? ? _required_property_map[:type] : required_property(:type, val)
+      end
+
+      def type
+        self.class.type
+      end
+    end
+  end
+end